API Reference
SupportAPI Feedback

Fetch Health Report Data

get
http://{environment}/api/v4/safetycam/health/report

API retrieves the health report data based on the user's query parameters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
1 to 500
Defaults to 100

The maximum number of items to be returned in a single response. Use it in conjunction with the offset parameter to paginate results

integer
≥ 0
Defaults to 0

Specifies the starting position of the data set

string
Defaults to UTC

Indicates the time zone used for the timestamp values in the response. '

string
Defaults to YYYY-MM-DD HH:mm:ss z

Specifies the format for the date & time values in the response.

string
enum
Defaults to %2BvehicleName

Sort order for health report data. Use '+' for ascending or '-' for descending, followed by one of the available fields: vehicleName, groupName, safetyCamSerialNum, lastConnectedAt, lastRecordingUpdatedAt, updatedAt, lastRecordingHealth, calibrationState, calibrationStateUpdatedAt, auxNum. Note: '+' must be URI-encoded as '%2B'.

string
length ≤ 255

Search query for health report data. Supports alphanumeric characters, spaces, and special characters: ', . _ - # ( ). The maximum length is 255 characters. Note: This field will not work if 'searchOn' is not provided

string
enum

Field to search on for health report data. Must be one of the allowed values. Note: This field will not work if 'search' is not provided

Responses

Updated 7 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago