v1

latestOpenAPI 3.0.0HERE Documentation License2026-07-142162791.8 MB
Traces

Gets traces within a specified time range

Gets all traces of the device trackingId that were recorded within the specified time range. The range is defined with before and after parameters. The returned traces are sorted in descending order based on their timestamps.

NOTE: By default, the after parameter value is 0, and the before parameter is set to the current system time. Always make sure to specify before and after parameters explicitly, as otherwise it may take a very long time for the API call to complete.

If the trackingId is substituted with a valid shipmentId, the response contains a composition of traces of each shipment segment. Traces are only fetched for those segments that are either in ongoing or completed state.

The outliers parameter can be used to select only traces that have been marked as outliers (if the parameter value is true), or only traces that have not been marked as outliers (if the parameter value is false). If the outliers parameter is not present, all the traces will be returned.

The count and pageToken parameters are used for pagination.

get/traces/v2/{trackingId}

Path parameters

trackingIdstring required

This is a unique ID associated with the device data in HERE Tracking. For physical devices the trackingId gets assigned to a device when the device is claimed by a user, and for virtual devices it is an external device ID along with the device project appId. Alternatively, a valid shipmentId may be used.

Query parameters

beforenumber

Milliseconds elapsed since 1 January 1970 00:00:00 UTC. The accepted range is from 1 to the current time.

afternumber

Milliseconds elapsed since 1 January 1970 00:00:00 UTC. The accepted range is from 0 to the current time.

outliersboolean

Flag specifying if only outliers (true) or only nonoutliers (false) are to be returned. If the parameter is not present both nonoutlier and outlier traces are returned.

mode'unknown' | 'normal' | 'flight' | 'transport' | 'sleep'

Tracker mode status of the device. When a tracker is in a normal mode, it can send telemetry and, for example, use its GNSS receiver if it has one. A tracker switches into flight mode once it detects that it's in an airplane, and leaves that mode once airplane lands. Transport mode has to be triggered by the user, and it's used, for example, during shipping from continent to another. Sleep mode is used when a tracker is stored in a warehouse, and it's triggered by entering or leaving some defined geofence.

Tracker mode.

smoothboolean

Flag telling if smoothed traces (true) or non-smoothed (false) traces should get returned. By default the traces are not smoothed.

The smoothing will have an effect on to the stationary trace points only.

pageTokenstring

A token from the previously returned response to retrieve the specified page.

countinteger

The number of records per page.

Response

Successful.

The response body contains an array of traces within the given time range (after <= timestamp <= before).

Traces are sorted in descending order based on their timestamps.

countinteger

The number of items in the response.

pageTokenstring

A token that can be used to retrieve the next page of the response.

Example response

{
  "count": 2,
  "data": [
    {
      "payload": {},
      "position": {
        "accuracy": "25",
        "alt": "86",
        "altaccuracy": "96",
        "lat": "52.4988217",
        "lng": "13.35170005"
      },
      "serverTimestamp": 1451425709682,
      "system": {
        "client": {
          "firmware": "10.1.1",
          "hasAttachSensor": true,
          "hasHumiditySensor": true,
          "hasPressureSensor": true,
          "hasTamperSensor": true,
          "hasTemperatureSensor": true,
          "manufacturer": "CONCOX",
          "model": "AT4H",
          "name": "MT2503",
          "platform": "MT6261",
          "version": "10.0.16"
        },
        "reportedSensorData": {
          "batteryLevel": 100,
          "deviceIsAttached": true,
          "deviceIsStationary": true,
          "deviceIsTampered": false,
          "pressureHpa": 994.342,
          "relativeHumidity": 31.39,
          "temperatureC": 24.48
        }
      },
      "timestamp": 1451425708571
    },
    {
      "payload": {
        "refAppData": {
          "batteryState": {
            "charging": false,
            "level": 61,
            "temperature": 26.9
          },
          "nwpos": true
        }
      },
      "position": {
        "accuracy": "25",
        "alt": "86",
        "altaccuracy": "96",
        "lat": "52.4988217",
        "lng": "13.35170005"
      },
      "serverTimestamp": 1451425710434,
      "system": {
        "reportedSensorData": {
          "batteryLevel": 100,
          "deviceIsAttached": true,
          "deviceIsStationary": true,
          "deviceIsTampered": false,
          "pressureHpa": 994.416,
          "relativeHumidity": 31.37,
          "temperatureC": 24.46
        }
      },
      "timestamp": 1451425708216
    }
  ],
  "pageToken": "1490376144514"
}