Gets a value of a shadow property

get

https://tracking.hereapi.com/shadows/v2/{trackingId}/{state}/{selector}

Gets a value of a single property of either desired or reported state objects of a device. One can use JSON selectors to specify the target property or reference it by name. In case the property contains an object, the entire object will be returned in the response.

The JSON selector can be nested like this: payload/time/minutes

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.

state

string

enum

required

Desired or reported state object of a device to query.

Allowed:

selector

string

required

A JSON selector that specifies the property.

Query Params

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.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

200Successful The content type is defined as "text/plain" or "application/json" depending on the type of the property.

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. Shadow doesn't exist

422The specified property doesn't exist in the shadow for the device.