Theme switcher

Get activity log

This API call returns a list of Activity Log objects

Header Parameters

x-api-keystring Required

Public API Key

Query Parameters

startDatestring

The starting date. Format: YYYY-MM-DD. If a cursor is provided for pagination, this field does not affect your query results. The default value is {TODAY}

Default value
The current timestamp
endDatestring

The end date (inclusive). Format: YYYY-MM-DD. This field should only be used to bind your data to a specific date range. Otherwise, you only require the start date and you can paginate through to all available data from that point.

clientIdstring

The specific client id to fetch data. The default value of -1 returns data "all users" Only one of the fields (clientId, groupId, deviceId) can be sent per request

deviceIdstring

The specific device id to fetch data. Only one of the fields (clientId, groupId, deviceId) can be sent per request

groupIdstring

The specific group id to fetch data. Only one of the fields (clientId, groupId, deviceId) can be sent per request

pageSizeinteger

The page size for number of results to return per request. The maximum value is 1000. The default value is 150.

Default value
150
cursorstring

The cursor for pagination. When a request is made without a cursor, the response returns results based on the date range. Each response returns a cursor. You should input the new cursor value for each subsequent request if you wish to paginate through additional data. If you do provide a cursor, the startDate no longer affects the result boundaries. This allows you to receive old records that have arrived late. If you receive no results with a valid/provided cursor, it means that no...

minDurationinteger

The minimum duration in seconds (inclusive). Only activities that have a duration greater than or equal to this value will be returned.

maxDurationinteger

The maximum duration in seconds (inclusive). Only activities that have a duration less than or equal to this value will be returned.

Response

200
Object
A response with the Report for Users.

Response Attributes

activityarray
Nullable:
True

Show child attributes

cursorstring
Nullable:
True
400
Object
Bad request. Failed StatusResponse with an error message indicating the reason of the failure.
500
Object
Internal Server Error.
Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?