Device Events

Returns device and stream lifecycle events (for example device boots, stream starts and stops, errors, config changes).

Required scope: device:read

Get Device Events

get

Returns device and stream lifecycle events (for example device boots, stream starts and stops, errors, config changes).

Authorizations
AuthorizationstringRequired

Roboflow API key passed as a Bearer token.

Path parameters
workspacestringRequired

Workspace ID (URL slug).

deviceIdstringRequired

Device ID.

Query parameters
limitinteger · min: 1 · max: 1000Optional

Number of events to return. Clamped to 1-1000.

Default: 100
entity_typestringOptional

Filter to events for a single entity type (for example "device", "stream").

entity_idstringOptional

Filter to events for a single entity ID.

eventstringOptional

Filter to events with this event name.

start_timestring · date-timeOptional

ISO 8601 timestamp lower bound. Returns 400 if not parseable.

end_timestring · date-timeOptional

ISO 8601 timestamp upper bound. Returns 400 if not parseable.

cursorstringOptional

Opaque pagination cursor from a previous response. Pass back next_cursor or prev_cursor. Malformed cursors return 400.

directionstring · enumOptional

Pagination direction. Other values return 400.

Default: backwardPossible values:
Responses
200

A page of events.

application/json
get
/{workspace}/devices/v2/{deviceId}/events

Example Request

Example Response

The device_timestamp, server_timestamp, and event_end_timestamp fields are formatted as YYYY-MM-DD HH:MM:SS[.SSS] in UTC. They are not normalized to ISO-8601 like other timestamps in this API.

event_end_timestamp may also be returned as the epoch-zero string "1970-01-01 00:00:00.000" (rather than null) when the event has no recorded end timestamp.

Last updated

Was this helpful?