OnTrack

Get current user

Get the profile of the OnTrack user the API token belongs to. Use this to find out who you are operating as (name, email, role, company context) or to verify that the API token works. Takes no parameters. Requires a read-scope OnTrack API token. Example response: { "id": 123, "name": "Jane Doe", "email": "jane@example.com", "cell": "5550100100", "country_code": "+1", "employee": false, "demo_user": false, "blocked_at": null, "mfa": false, "current_company": { "role": "AD

Get my permissions

Get the permissions the API token's user has in their current company context — everything granted to their role plus any per-user grants. The response is a map of permission name to true; a permission that is not listed is not granted. Permission names are module:action strings (e.g. event:view, incident:view_all, task:create). Use this to check what the current user is allowed to do before calling other tools or answering capability questions ("can I archive events?"), and to explain any Perm

List companies

List the OnTrack companies the API token has access to — the caller's own company plus any subsidiaries their role can see. Use this to resolve a company name to its id before calling tools that take company_id or company_ids (get_events, get_incidents, and the analytics tools), or to enumerate which companies the token can query at all. The list is compact (id, name, category) and not paginated. Pass company_categories to narrow by category (venues, festivals, standard); omit it to list every v

List events

List and search OnTrack events the API token has access to. All filters are optional and combine (AND). Use keyword to search by event name; use status to narrow (upcoming, in_progress, completed, on_hold). To filter by date, pass both public_start_date and public_end_date — events whose public dates overlap that window are returned. Use this to resolve an event name to its id before calling event-scoped tools such as get_incidents (pass the id as event_id). Results are paginated — check paginat

Get top events by incident count

Rank OnTrack events by how many incidents they generated — answers "which events are generating the most incidents?" with the same ranking the Global Dashboard top-events widget shows for the same filters. Each entry has the event id and name (as in get_events), its incident count, and that count as a percentage of all incidents matching the filters. All filters are optional and combine (AND): use start_date/end_date to restrict the range, event_ids/company_ids/ event_status to scope which event

Get event analytics

Count OnTrack events grouped by company, region, event category, status, or month — one aggregate call instead of paging through get_events. Use this for "events per venue / per year", "events per month" and similar reporting questions. Pick the dimension with group_by: - company: one row per company that owns events (pass a parent in company_ids with company_categories ["venues"] to get one row per venue sub-company), sorted by event_count desc - region: one row per region of the owning com

List incident types

List the OnTrack incident types of the API token's accessible companies. Use this to resolve an incident type name to the id that get_incidents takes as incident_type_id, or to enumerate the type catalog itself. All filters are optional: company_id/company_ids scope to specific companies (a parent company includes its sub-companies; resolve names with get_companies first); event_id/event_ids narrow to types associated with those events; disabled=true additionally includes locked/disabled types (

List incidents

List and search OnTrack incidents the API token has access to. All filters are optional and combine (AND). Use keyword to search by description, locator code, staff name, incident type, or incident id; use event_id/event_ids to scope to one or more events (resolve event names to ids with get_events first); use event_status to filter by the status of the incident's event without calling get_events (e.g. incidents at in_progress events); use status/priorities to narrow. Id-based filters (incident_

Get incident counts

Get one event's incident counts grouped by status and priority — the same tallies the OnTrack web app shows above the incident listing. Use this instead of paging through get_incidents when only totals are needed ("how many open incidents does event X have?"). event_id is required — resolve event names to ids with get_events first. All other filters are optional and combine (AND) to narrow what is counted, with the same semantics as get_incidents. totalCounts breaks each status down by priority

Get incident by id

Get one incident by id: the full detail record the OnTrack web app shows when an incident is opened — status, priority, description, type, zone/location, divisions, dispatched staff, reporter, and resolution note. Use this when the user asks about one specific incident; use get_incidents to search or list. Both incident_id and event_id are required — get_incidents rows carry both. When the top-level incident_type_lock is true, the caller's account is locked to core incident types: report the inc

Get linked incidents

Get the incidents linked to one incident — related occurrences the operations team associated with it (e.g. a fight and the resulting medical response). Rows have the same shape as get_incidents rows. Both incident_id and event_id are required. Pass show_all: true to also include second-level links (incidents linked to the linked incidents). Requires a read-scope OnTrack API token. Example response: { "linked_incidents": [ { "id": 4830, "status": "resolved", "priority":

Get incident change logs

Get one incident's change log — the audit trail of every edit (status changes, priority changes, dispatches, description edits, …) with who made it and when. Use it to reconstruct the timeline of an incident ("when was it dispatched and by whom?"). Both incident_id and event_id are required; results are paginated, newest first by default. change_column: "status" narrows to status changes only; keyword searches the formatted log text. Requires a read-scope OnTrack API token. Example response: {

Get incident images

Get one incident's attachments — the images and files uploaded to it, each with its URL, uploader, and upload time. Only incident_id is required. Requires a read-scope OnTrack API token. Example response: { "images": [ { "id": 3310, "name": "north-gate.jpg", "url": "https://cdn.us-west-1.ontrack.co/images/north-gate.jpg", "createdBy": "Jane Doe", "created_at": "2026-08-01T18:26:41.000Z" } ] } Downstream authorization: the user's role must hold at least

Get incident comments

Get one incident's comments — the notes the operations team wrote on it, with author and time, newest first. Only incident_id is required; results are paginated. Requires a read-scope OnTrack API token. Example response: { "comments": [ { "id": 7742, "text": "Medic team arrived, patient stable", "creator_name": "Jane Doe", "created_at": "2026-08-01T18:31:12.000Z" } ], "pagination": { "total_count": 6, "total_pages": 1, "current_page": 1 } } Downstream autho

Get incident dispatch logs

Get one incident's dispatch log — every staff member dispatched to it, with their role, contact, current status, and scan activity (dispatched / in_route / at_scene timestamps), plus who created the incident. Only incident_id is required; keyword narrows to staff whose name matches. Requires a read-scope OnTrack API token. Example response: { "dispatch_logs": { "id": 4821, "creator_name": "Control Room", "users": [ { "id": 55, "name": "Jane Doe", "rol

Get incident deep links

Get one incident's deep links — the shareable URLs that open it directly in the OnTrack apps. Use this when the user wants a link to an incident. Only incident_id is required. Requires a read-scope OnTrack API token. Example response: { "deep_links": [ { "id": 120, "incident_id": 4821, "link": "https://app.ontrack.co/incidents?incident_id=4821", "created_at": "2026-08-01T18:22:11.000Z" } ] } Downstream authorization: the user's role must hold at least one of

Get dashboard stats

Get the OnTrack Global Dashboard headline numbers in one call: events breakdown by status (Upcoming / In Progress / On Hold / Completed), incidents breakdown by status (Open / Dispatched / Follow Up / Resolved), and summary counts including active, critical, and legal incidents. All filters are optional and combine (AND): use start_date/end_date to restrict the range, event_ids/company_ids/ event_status to scope which events are counted, and time_zone to resolve "today" and the 24h change window

Get incident analytics

Get OnTrack incident counts grouped by status, priority, incident type, region, or company — the same numbers the Global Dashboard charts show for the same filters. Pick the dimension with group_by: - status: counts keyed by status name (Open, Dispatched Total, Follow Up, Resolved, ...) - priority: counts keyed by priority name (Low, Medium, High, Critical) - type: list of core incident types with count and percentage of total, sorted by count - region: list of regions with per-priority co

Get incidents over time

Get OnTrack incident volume as a daily time series — answers trend questions like "is incident volume going up this week?" with the same numbers the Global Dashboard over-time graph shows for the same filters. Returns one entry per day covering the requested range (days with no activity are included with zero counts), each with the number of incidents logged (incident_count) and event RECORDS CREATED that day (events_created_count — by created_at, not by when the event takes place; bulk clones/i