Request a data export

Starts an asynchronous export of a device's metrics, states and events for a period, delivered as a ZIP of XLSX (default) or CSV files. Poll the export until its status is completed, then download it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Permission: View permission on the device (machines:view or machines:manage).

Parameters can be sent as JSON body or query string. An identical request (same user, device, period, filters, language and format) returns the export already in progress, or one completed in the last hour, instead of creating a new one. Limit: 30,000,000 rows per export (400 above it); the period itself has no maximum. Each file in the ZIP holds at most 500,000 rows. Exports are private to the user who requested them and are kept for 7 days. 400 also for missing/invalid from/to, from not before to, future dates, invalid include/format, more than 100 names. Status values: pending, running, completed, failed.

Path Params
string
required

Device id

Body Params
string
required

Start of the period. Must be before to and not in the future. Truncated to the minute.

string
required

End of the period. Not in the future. Truncated to the minute.

string
Defaults to metrics,states,events

Kinds of data to export. Omitted or empty = all three. Allowed: metrics, states, events.

string

Metric names to export (max 100). Names with characters other than letters, digits, _, -, . are ignored. Omitted = every metric.

string

State names to export (max 100). Omitted = every state.

string

Event names to export (max 100). Omitted = every event.

string
Defaults to true

false exports raw names; otherwise labels are translated into the user's language. Allowed: true, false.

string
Defaults to xlsx

Format of the files inside the ZIP. Allowed: xlsx, csv.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json