Illumience API

GET /v2/telemetry

Request

# All customer devices
curl -k "https://api.illumience.com:11443/v2/telemetry?from=1709251200&to=1709337600&limit=100" \
  -H "Authorization: Bearer <api_key>"

# Specific devices only
curl -k "https://api.illumience.com:11443/v2/telemetry?from=1709251200&to=1709337600&device_ids=66e0b123c0d7400c7d909dba,66e0b456c0d7400c7d909dbb" \
  -H "Authorization: Bearer <api_key>"

Query Parameters

ParameterRequiredTypeDefaultDescription
fromYesintegerStart time as Unix timestamp (seconds)
toYesintegerEnd time as Unix timestamp (seconds)
limitNointeger1000Max records per device (1 - 10,000)
device_idsNostringComma-separated MongoDB ObjectId hex strings
next_cursorNofloatPagination cursor (applies to all devices)

Constraints

  • Same time range validation as the single-device endpoint
  • Maximum 20 devices per request
  • If device_ids is omitted, all customer devices are queried (fails with 400 if the customer has more than 20 devices)

Response 200 OK

{
  "devices": [
    {
      "device_id": 4521,
      "total": 50,
      "has_more": false,
      "next_cursor": null,
      "pings": [ ... ]
    },
    {
      "device_id": 4522,
      "total": 30,
      "has_more": true,
      "next_cursor": 1709308801.0,
      "pings": [ ... ]
    }
  ]
}

Response Fields

FieldTypeDescription
devicesarrayList of per-device telemetry results

Per-Device Object:

FieldTypeDescription
device_idintegerNumeric device identifier
totalintegerNumber of pings returned for this device
has_morebooleanWhether more records exist for this device
next_cursorfloat or nullPagination cursor for this device
pingsarrayPing objects (same format as single-device endpoint)

Errors

CodeCause
400Missing from/to, invalid range, too many devices, invalid ObjectId in device_ids