Generate a Tracker Report

post

https://api.tive.com/public/v3/Devices/{deviceId}/generateReport

Creates a report of sensor data for the specified tracker.

Path Params

deviceId

string

required

The tracker you would like to run a report on.

Body Params

format

string

required

length ≥ 1

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

sensorData

array of strings

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.

sensorData*

timeZone

string

required

length ≥ 1

The timezone that report timestamps will display in.

users

array of strings | null

A list of user IDs to share the report with.

users

dateTimeStart

date-time

required

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

dateTimeEnd

date-time

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

Headers

x-tive-account-id

int32

required

ID of the account the request will be made in.

Responses

202

Tracker report created and will be available once generated.

400

Unable to generate the tracker report. See response message for details.

401

Unauthorized

500

Internal Server Error

Language

Response

Click Try It! to start a request and see the response here!