Device Heartbeat

APIs to retrieve information about device's heartbeat which contains the last seen details.

Get heartbeat of a device which contains last seen information

SecurityapiKey
Request
path Parameters
id
required
string <uuid>

ID of the device

Responses
200

Last seen details of the device

401

Authorization information is missing or invalid.

404

Not found

500

Internal Server Error

get/device/v0/heartbeat/{id}/
Request samples
curl -i -X GET \
  'https://develop-api.esper.cloud/api/device/v0/heartbeat/{id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Get list of heartbeat for all devices

SecurityapiKey
Request
query Parameters
last_seen_gt
required
string <date-time>

Specify the starting date and time for device lookup in the format (2023-08-29T00:00:00Z).

Example: last_seen_gt=2023-08-29T00:00:00Z
last_seen_lt
required
string <date-time>

Specify the end date and time for device lookup in the format (2023-08-30T00:00:00Z).

Example: last_seen_lt=2023-08-30T00:00:00Z
platform
string

platform of the device

Enum: "ANDROID" "APPLE"
limit
integer
offset
integer
Responses
200

Last seen details of the device

400

Device create error - Bad Request

401

Authorization information is missing or invalid.

500

Internal Server Error

get/v2/heartbeat/
Request samples
curl -i -X GET \
  'https://develop-api.esper.cloud/api/v2/heartbeat/?last_seen_gt=2023-08-29T00%3A00%3A00Z&last_seen_lt=2023-08-30T00%3A00%3A00Z&platform=ANDROID&limit=0&offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}