List all Reports

List all Reports

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

Optional device name, the unique id of a device to get reports for.

string

Filter reports by a key inside the JSONB payload column. Replace * with the key name (e.g. payload.status=ok). Nested keys are addressed with further dots (payload.sensor.reading=12).

Operator suffixes apply as they do elsewhere: _ne, _gt, _gte, _lt, _lte, _in, _nin, _like, _ilike, _notlike. Comparisons are on the key's text value, except _gt/_gte/_lt/_lte with a numeric filter value, which compare numerically and match only rows where that key holds a JSON number.

payload.<key>=null matches reports where the key is absent or holds JSON null; payload.<key>_ne=null matches where it is present. Note that _ne with any other value excludes rows missing the key, since there is nothing to compare.

payload_inc=<keys> matches reports having any of the listed keys and payload_incall=<keys> reports having all of them (comma-separated).

Filtering is applied within the query's time range, which defaults to the last 30 days when no created_at filter is supplied.

string

Alias for payload.* — reports store their document in the payload column, but it is commonly referred to as the report's data (the report type is itself data). Both spellings resolve to the same column.

integer
≥ 1
Defaults to 1

Page number for pagination

integer
1 to 100
Defaults to 20

Number of items per page

Responses

401

You are not authorized

404

The item you were looking for does not exist

500

An unexpected error was encountered.

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