Devices

Generate a Tracker Report

Creates a report of sensor data for the specified tracker.

post/public/v3/Devices/{deviceId}/generateReport

Path parameters

deviceIdstring required

The tracker you would like to run a report on.

Headers

x-tive-account-idinteger required

ID of the account the request will be made in.

Request body

formatstring required

The format of the report. Values include PDF, PdfRawData, or CSV.

sensorDatastring[] required

The sensor fields you would like to include in your report. At least one of the following values must be specified: Location, Temperature, ProbeTemperature, Humidity, Pressure, Light, Motion, Acceleration, Battery.

timeZonestring required

The timezone that report timestamps will display in.

usersstring[] nullable

A list of user IDs to share the report with.

dateTimeStartstring date-time required

The UTC start date and time within the last 3 months of data to be reported on.

dateTimeEndstring date-time

The UTC end date and time of data to be reported on. Defaults to now.

Response

Tracker report created and will be available once generated.

Changes

No recorded changes to this endpoint across all 1 revision of this API.