Gets event history for a device or a shipment

get

https://tracking.hereapi.com/events/v3/{trackingId}

Gets all events for a device or a shipment. A device is identified by the trackingId. For shipments, shipmentId can be used as a trackingId.

The results are listed in descending order based on the timestamp.

An event is uniquely identified by trackingId-ruleId-timestamp key, with an exception of dwelling and stock rule events. Dwelling events also need geofenceId to be specified, whereas for stock events trackingId is not applicable.

A single event can be fetched using ruleId, before and after query parameters.

A time range can be defined with before and after timestamps. The response will contain an array of events that were recorded within the range. The default value for before parameter is the current time, and for the after parameter it is one day in the past from the current time. The after parameter value is not allowed to be earlier than two weeks in the past from the before timestamp, otherwise an error is returned.

If the request is supplied with eventSource query parameter, the response will contain events generated by the defined source only.

If the request is supplied with eventType query parameter, the response will contain events of the specified type only.

If the request is supplied with ruleId query parameter, the response will only contain events for the specified rule ID.

If the request is supplied with initialState query parameter, the response will contain events having the specified initial state.

All the aforementioned query parameters can be combined together.

Path Params

trackingId

string

required

length between 1 and 50

This is a unique ID associated with the device data in HERE Tracking. The trackingId gets assigned to a device when the device is claimed by a user. Alternatively, a valid shipmentId may be used.

Query Params

before

number

≥ 1

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

after

number

≥ 0

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

eventSource

enum

eventType

enum

ruleId

initialState

boolean

Events with the initialState property set as true are generated when the rule is evaluated for the first time. It indicates the fact that this is the initial evaluation state, which would serve as a starting point for the subsequent rule evaluations. The rest of the rule events would represent a transition of a device or a shipment or a geofence from one state to another and their initialState property will be set to false.

pageToken

string

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

count

integer

1 to 1000

Defaults to 1000

The number of items to return per page.

appId

string

length ≥ 8

Application identifier. Used together with an external ID to identify a virtual device.

Headers

X-Request-Id

uuid

ID used for correlating requests within HERE Tracking. Used for logging and error reporting.

Must be a valid UUIDv4.

Responses

200Successful The events were successfully retrieved.

400Bad request The request object is in an incorrect format or has values that are invalid or out of range. If available, further error details are provided in the response body.

401Unauthorized The request did not provide correct authentication details

403Forbidden The account does not have the correct privileges

404Not Found The specified resource was not found