Articles in this section

See more

Get Locations Health

Avatar
John Twomey
  • Updated
Follow

Retrieves health information for all subscribed locations. It is recommended that this endpoint is accessed using the read-only endpoint.

GET ~/health/locations?since=,inverse=,sort=

Parameters

Field Type Description
sinceoptional Integer

The date and time (seconds since Epoch) <= Location's last heartbeat. Eg. 1481979234
inverseoptional Boolean

Inverse the results to only show locations that haven't sent heartbeats, e.g. true/false. Default: false
sortoptional String

Sort locations ascending: asc or descending: desc based on last heartbeat date. Default is desc.

Response

Field Type Description
  locationId String

Unique hashed id for the Location. See Hashed Location IDs
  name String

The name of the Location
  heartbeat String

The date and time in UTC of when Doshii last received a heartbeat from this location.

 

Examples

Response

HTTP/1.1 200 OK
[
  {
    "locationId":"xyDhd32v",
    "name":"Chicken's R Us",
    "heartbeat":"2018-07-27T04:10:11.208Z"
  },
  {
    "locationId":"abc123YZ",
    "name":"Burger Time",
    "heartbeat":"2018-07-27T04:09:34.208Z"
  },
  {
    "locationId":"fr45H23l",
    "name":"Shop Around",
    "heartbeat":null
  }
]

 

Related articles

Comments

0 comments

Please sign in to leave a comment.