Get containers report

Historical shipping-container tracking powered by the container-ID OCR engine. One row per
container serial number per day.

Extracts itemized historical records for the application's organization. timeRange
({ startTime, endTime } in milliseconds since epoch) is required; the window may not exceed
92 days. locations and cameras (GUID arrays) are optional
scope filters; when omitted the report covers all cameras of the organization. Dates are aligned to
timezone (IANA, default UTC). Results are paginated with page/size (zero-based page, size
1..100, default 50); the envelope always
carries total, so total can exceed items.length.

Send Accept: text/csv to receive the current page as CSV (columns = the item fields) instead of
the JSON envelope; the CSV response carries X-Total-Count/X-Page/X-Size headers.

Required scope: read:reports

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

Starts the CSV with a UTF-8 byte-order mark, so spreadsheet apps such as Excel show non-Latin text (Hebrew, Chinese, Japanese) correctly; the response is then typed text/csv; charset=utf-8. Accepts true or false; omitted or false sends the CSV without a mark. Ignored when the response is JSON.

Body Params
timeRange
object
required

The query window, milliseconds since epoch.

locations
array of strings

Location GUIDs to filter by. Optional.

locations
cameras
array of strings

Camera GUIDs to filter by. Optional.

cameras
string
Defaults to UTC

IANA timezone used to align dates. Defaults to UTC.

number
Defaults to 0

Zero-based page index.

number
Defaults to 50

Page size (1..100).

Responses

400

Invalid timeRange, date range too large, or invalid pagination.

500

Internal server error.

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