Sign in

v1

latestOpenAPI 3.0.32026-07-26134195287.9 KB
Analytics

Get Occupancy Trend Data

Returns all occupancy trends data for a particular camera over a specified time range.

Responses will include the start and end time of the data requested and device information (ID, serial number) alongside the readings.

get/cameras/v1/analytics/occupancy_trends

Query parameters

camera_idstring required

The unique identifier of the camera.

start_timeinteger

The start of the time range for occupancy trends. Formatted as a Unix timestamp in seconds. Defaults to an hour from the current time.

end_timeinteger

The end of the time range for occupancy trends. Formatted as a Unix timestamp in seconds. Defaults to the current time.

interval'15_minutes' | '1_hour' | '1_day'

An enumeration.

type'person' | 'vehicle'

An enumeration.

preset_idstring

The unique identifier of the camera preset.

Response

OK

camera_addressstring

The address of the site for the camera.

camera_idstring

The unique identifier of the camera.

camera_namestring

The name of the camera.

camera_sitestring

The name of the site for the camera.

end_timeinteger

The end of the time range for occupancy trends.

org_idstring

The unique identifier of the organization.

org_namestring

The name of the organization.

preset_idstring

The unique identifier of the camera preset.

start_timeinteger

The start of the time range of occupancy trends.

type'person' | 'vehicle'

An enumeration.