Skip to navigation

Get an instrument's device status history

View as Markdown

Get an instrument’s device status history.

Returns the current status of the instrument’s paired device and the periods it was online, offline, or in error, trimmed to the range and oldest first. Gaps between the device’s reports are returned as offline periods. current_status gives the status now and when it began, or is null if the device has never reported; it is offline since the last heartbeat once the device stops sending heartbeats. Use it to answer questions about connectivity or to reason over it, such as counting disconnections, comparing instruments, or lining up offline periods with runs. Times are ISO 8601 with a UTC offset. end_time defaults to and is capped at now, and start_time defaults to 7 days before end_time. A range with more than 200 periods returns the most recent 200. The “notes” field flags when the range was adjusted, e.g. because the end was capped at now or earlier periods were dropped.

Requires an API key with the read scope.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

instrument_idstringRequired

Query parameters

start_timedatetime or nullOptional
end_timedatetime or nullOptional

Response

OK
instrumentobject
start_timedatetime
end_timedatetime
current_statusobject or null
The device's status now, or null if it never reported
statuseslist of objects
Status periods in the range, oldest first
noteslist of strings
How the returned range differs from the requested one

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error