Skip to content
API Reference/Historical data/
Request historical locati...

Trackonomy External API (1.3.0.0)

External APIs are meant for interacting with Trackonomy Platform. New endpoints will be added regularly. Current APIs enable the following:

  • retrieve location and environmental data for assets tracked with Trackonomy tapes.
  • decode Trackonomy BLE packets
  • send various messages from third party systems for integration purposes

Locations endpoint can be used for the latest event, Historical data endpoint reveals also older data with about 15 minute delay. Note that today authentication is separated for the 2 location data endpoints!

Download OpenAPI description
trackonomy-external-api.json
trackonomy-external-api.yaml
Overview
URL
https://trackonomy.ai/contact-us/
Developer Support
developers@trackonomysystems.com
Languages
Servers
Mock server
https://docs.trackonomy.com/_mock/external-api/trackonomy-external-api/
PPE API for Locations data
https://ppe.api.trackonomy.com/external/
PPE API for Historical data
https://ppe.mt.trackonomysystems.com/

Locations

This API allows to request location and environmental data for assets tracked with Trackonomy tapes.

available sensor data depends on the exact model of tape used and sensor configuration applied to the specific device. Value -255 indicates sensor unavailability.

location_detailed info can only be returned if Trackonomy indoor network is used by customer at the given location.

Operations

Historical data

This endpoint allows requesting historical location and environmental data based on provided filters. Up to 1 year of history is available, at once maximum 1 month or 1000 events can be fetched. If no time frame provided, the latest event is returned.

Operations

Request historical location and environmental data

Request

Returns historical data.

Security
bearerAuth
Headers
customer_idstringrequired

Customer ID for the request

Example: c89c432b-12b7-4956-8be4-904a5e95df23
authorized_groupsstringrequired

Authorized groups for access control

Example: cb2c60c7-9b47-41af-ab05-9d3fdbff44e5
Bodyapplication/jsonrequired
contextobjectrequired
context.​authorized_groupsstring(uuid)required
Example: "cb2c60c7-9b47-41af-ab05-9d3fdbff44e5"
context.​customer_idstring(uuid)required
Example: "c89c432b-12b7-4956-8be4-904a5e95df23"
context.​filtersobjectrequired
One of:
context.​filters.​customer_asset_idstring

customer asset identifier, connected to Trackonomy tape

Example: "999-2440 0001-0001"
context.​filters.​event_typestring

location option returns data without sensor readings, environment option returns both location and sensor data.

Enum"location""environment"
Example: "environment"
context.​filters.​fromstring(date-time)

show events from this date, time in UTC

Example: "2025-02-07T09:02:34Z"
context.​filters.​tostring(date-time)

show events until this date, time in UTC

Example: "2025-02-07T09:02:34Z"
context.​filters.​trk_asset_idstringrequired

Trackonomy tape QR Code

Example: "9E-240125-08-K1B226"
curl -i -X POST \
  https://docs.trackonomy.com/_mock/external-api/trackonomy-external-api/agent-service/v1/agent/exec/e4735852-45a4-4d73-a4b4-b13b60fc5dfe \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'authorized_groups: cb2c60c7-9b47-41af-ab05-9d3fdbff44e5' \
  -H 'customer_id: c89c432b-12b7-4956-8be4-904a5e95df23' \
  -d '{
    "context": {
      "authorized_groups": "cb2c60c7-9b47-41af-ab05-9d3fdbff44e5",
      "customer_id": "c89c432b-12b7-4956-8be4-904a5e95df23",
      "filters": {
        "customer_asset_id": "999-2440 0001-0001",
        "event_type": "environment",
        "from": "2025-02-07T09:02:34Z",
        "to": "2025-02-07T09:02:34Z",
        "trk_asset_id": "9E-240125-08-K1B226"
      }
    }
  }'

Responses

Historical location and environmental data

Bodyapplication/json
dataobject
Response
application/json
{
  "data": {
    "events": [ … ],
    "version": "1.2.0"
  }
}

Device Management

Service to decode BLE packets either one by one or in batch

Operations

Messaging

Service to process external messages and modify device status based on the inputs. NB! Usage of the given API needs prior alignment with customer as each received message and intended behavior is different. Provided examples are some possible ways to use the endpoint.

Operations
Copyright Trackonomy Systems Inc