Tracker API

Programmatic access to devices, sessions, and telemetry.

Every workflow you can do in the chrt UI for tracking — registering a device, creating a session, terminating it, reading telemetry — is also available over the chrt API. Use this page as the index of relevant endpoints; the full request and response schemas live in the API reference.

All endpoints require an API key unless explicitly marked public. Public endpoints exist only after a session has been made public in the UI or via the update session endpoint. See the public-session warning below.

Devices

Manage the hardware records registered to your organization.

Sessions

A tracking session is the bounded recording of pings for one device. See Standalone trackers for the UI flow and Tracking concepts for the data model.

Session telemetry by device

Read raw pings and last-known location for the active session on a device. Two flavors: authenticated endpoints (any session on your org’s devices) and public endpoints (only for sessions that have been made public).

Creating a session

You can create a session two ways:

Making a session public

You can make a session public from the sessions dashboard, from the session detail page, or by calling the update session endpoint and setting the visibility field. Public sessions are reachable by anyone with the URL — no chrt account required.

Once you make a session public, you cannot make it private again. Your only options are to terminate the session (recording stops, the public URL keeps history) or delete the session entirely (history goes away too).

Deleting a session

You can delete a session from the sessions dashboard or from the session detail page. A public API endpoint for deletion is not currently documented — contact trackers@chrt.com if you need programmatic deletion.

How to know it worked

  • A successful register device call returns the new device document with _id, MAC address, and registration timestamp.
  • A successful create session call returns the session with _id, device reference, and termination settings.
  • The first telemetry ping can take up to about 15 minutes to appear via the data-points endpoints after a session starts.
  • Standalone trackers — the full UI flow these endpoints back.
  • Integrations — Tive sync endpoints and the programmatic shipment-level model.
  • Sharing — give a connected org access to a session (UI flow; the API equivalent is the session update endpoint).
  • Tracking concepts — devices, sessions, and pings in detail.
  • API reference — full schemas and authentication.