List all devices within geographic bounding box

get https://api.edgeiq.io/api/v1/platform/devices/in_bounding_box/{top_left_coordinate}/{bottom_right_coordinate}

List all devices with last known coordinates within the geographic bounding box described by top_left_coordinate and bottom_right_coordinate. The top left coordinate is expected to be the northwestern-most coordinate. A coordinate must be a valid WSG84 compatible latitude longitude pair in the form <latitude>,<longitude>. Valid latitudes and longitudes are parsable from the strings as floating point values, and are between -90 and 90 for latitudes and -180 and 180 for longitudes.

Responses

Response body

array of objects

object

_id

string

A unique id for this Device.

company_id

string

Company account id for this device. If left blank, defaults to current user's company id on creation.

name

string

required

A descriptive name for this Device.

unique_id

string

required

A unique identifier for the device. Must be globally unique. For gateway devices running our edge service, this ID will uniquely identify this gateway when it requests its configuration from the cloud. Allowed to contain only lower or uppercase letters, numbers, colons, underscores, or dashes (the characters :, -, or _).

device_type_id

string

required

The _id of the Device Type

activated_at

boolean

Indicates that the device is marked as activated in another system. Currently applies only to cloud-native devices. Exclusive of deactivated_at.

deactivated_at

boolean

Indicates that the device is marked as deactivated in another system. Currently applies only to cloud-native devices. Exclusive of activated_at.

heartbeat_period

integer

Defaults to 60

The interval (in seconds) that the heartbeat message will be sent.

heartbeat_status

string

The status of the device based on received heartbeat values

online offline idle never_reported

heartbeat_values

array of strings | null

An array of strings indicating what values should be included in the heartbeat message.

heartbeat_values

authentication_method

string of strings | null

Method used for authenticating with MQTT (e.g. password, certificate)

tags

device_certificates

array of objects | null

An array of device certificates

device_certificates

object

string

Unique identifier for the device certificate

certificate_id

string

ID of the certificate

created_at

date-time

Date and time the certificate was created

updated_at

date-time

Date and time the certificate was last updated

company_id

string

ID of the company that owns the device

device_id

string

ID of the device

device_unique_id

string

Unique ID of the device

serial_number

string

Serial number of the certificate as a hexadecimal string

issue_date

date-time

Date and time the certificate was issued

expiration_date

date-time

Date and time the certificate will expire

first_connected

date-time

Date and time the device first connected

first_connected_ip

string

IP address of the device during the first connection

last_connected

date-time

Date and time the device last connected

last_connected_ip

string

IP address of the device during the last connection

revoked

boolean

Status of the certificate, true if revoked

certificate_pem

string

PEM-encoded certificate

last_used_client_id

string

Last used client ID with the certificate

ingestor_ids

array of strings | null

IDs of associated Ingestors (deprecated, optional).

ingestor_ids

command_ids

array of strings | null

IDs of associated Commands (deprecated, optional).

command_ids

attached_device_ids

array of strings | null

attached_device_ids

last_report_id

string | null

The ID of the last report received for this device. Field will be undefined if no reports exist.

last_location_observation_id

string | null

The ID of the last device location observation received for this device. Field will be undefined if location observation doesn't exist.

log_config

object | null

location

string | null

A textual (non-geographic) location for keeping track of the location of a device. For example "Warehouse", "Building One".

last_known_geographic_location

object | null

GeoJSON Feature representation of the device's last known location, with the radius of accuracy in properties.radius. If this device has received any device location observations, the latest device location observation's geographic coordinates will be returned here on the device as well.

Has additional fields

metadata

object | null

A key/value object of user defined data

Has additional fields

active

boolean

deprecated

[deprecated] Indicates whether or not the Device is available. No longer used.

401

You are not authorized

404

The item you were looking for does not exist

500

An unexpected error was encountered.

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.edgeiq.io/api/v1/platform/devices/in_bounding_box/top_left_coordinate/bottom_right_coordinate?page=1&per_page=20' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success