Here

HERE Tracking

HERE Tracking is a cloud product designed to address location tracking problems for a wide range of Location IoT industry verticals. HERE Tracking also…

Maps & location#openapi#location

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

HERE Tracking is a cloud product designed to address location tracking problems for a wide range of Location IoT industry verticals.

HERE Tracking also includes end-user mobile and web applications that can be used to demonstrate the product.

Endpoints 216

Ingestion

  • POSTIngests data and receives a shadow/v2/?async=falseDevices can use this end point to ingest data into HERE Tracking, in the same way as via the /v3 endpoint. A device uses its access token obtained via the the…
  • GETGets service health/v2/health
  • GETGets the current timestamp/v2/timestampReturns the current server time in seconds since the UNIX epoch. The server time is used to check the validity of the OAuth 1.0 header of a device data…
  • POSTRequests a token for a registered device/v2/tokenAuthenticates a device to HERE Tracking and requests a device access token. A device must provide a valid device access token when it sends telemetry to HERE…
  • GETGets service version/v2/version
  • POSTIngests data for a device and receives a shadow/v3/?async=falseDevices can use this end point to ingest data into HERE Tracking. A device uses its access token obtained via the the /v2/token endpoint to send telemetry –…
  • POSTIngests data for multiple devices/v3/batchDevice owner use this endpoint to ingest data to HERE Tracking on behalf of multiple devices. A single request can contain data for multiple devices. The…
  • GETGets service health/v3/health
  • GETGets service version/v3/version

Largedata

  • POSTCreates a new data upload/largedata/v4Creates a new multipart large data upload. Response contains dataId, which is the created large data object identifier.
  • GETGets metadata listing for all large data for a device/largedata/v4/devices/:trackingId/metadata?pageToken=string&limit=100Gets metadata listing for all large data objects for a given device.
  • GETGets service health/largedata/v4/health
  • GETGets service version/largedata/v4/version
  • POSTCompletes data upload/largedata/v4/:dataId?abort=falseAfter all parts have been uploaded, this operation completes the upload. When the upload has been completed, it is no longer possible to upload new parts to…
  • DELETEDeletes large data/largedata/v4/:dataIdDeletes large data object.
  • GETGets large data object/largedata/v4/:dataId/data?offset=0&count=1Downloads a part of large data. The data to be downloaded is identified with dataId. offset query paremeter specifies the first byte of the data, and count…
  • GETGets metadata for a large data object/largedata/v4/:dataId/metadataGets metadata for a large data object.
  • GETGets parts information listing for a large data object/largedata/v4/:dataId/parts?pageToken=string&limit=100Gets information about uploaded parts for a large data object.
  • PUTUploads a part of a large data/largedata/v4/:dataId/parts/:partNumber?md5=stringUploads a part of large data. The part is identified with dataId and a part number. Part upload has the following limits: * The part numbers must start from…

Registry

  • GETGets the trackingId for a device/registry/v2/devices/:deviceOrExternalId?appId=stringGets the trackingId for a claimed device by its deviceId.
  • PUTClaims a device/registry/v2/devices/:deviceOrExternalId?appId=string&projectId=stringClaims a device, associating a device to a user account. The user who claimed a device is the device owner, which is different from the device vendor.…
  • DELETEDeactivates a device./registry/v2/devices/:deviceOrExternalId?appId=stringDeactivates a provisioned device. This operation will deactivate the device license (deviceId and deviceSecret). Deactivated devices cannot be claimed…
  • GETGets service health/registry/v2/health
  • GETGets a list user projects along with the license information/registry/v2/licenses?startIndex=0&endIndex=100&projectIds=string&projectTypes=indoorGets a list of projects the user is a member of, along with the license information details for each project.
  • GETGets service version/registry/v2/version
  • GETLists all the devices provisioned by a user/registry/v2/:appId/devices?pageToken=string&count=100Lists all the devices provisioned by a user project identified by the appId.
  • POSTCreates licenses for multiple devices/registry/v2/:appId/devices?autoclaim=falseStarts a batch job to create licenses for either physical devices or virtual devices. Virtual devices are meant for cloud-to-cloud use case. A physical device…
  • GETGets a number of device licenses provisioned by a user/registry/v2/:appId/licenseCountGets a number of provisioned device licenses for a user project identified by the appId.
  • POSTCreates a license for a single physical device/registry/v2/:appId/one-device?autoclaim=falseDevice license is a deviceId and deviceSecret credential pair. The created credentials will be returned in the response body. If autoclaim query parameter is…
  • GETGets the multiple device license request job results/registry/v2/:jobId/results?pageToken=string&count=100Gets results of a previously created multiple device license request batch job upon its successful completion.
  • GETGets the multiple device license request job status/registry/v2/:jobId/statusChecks the progress of a previously created multiple device license request batch job.
  • GETGets the deviceId/registry/v2/:trackingId?appId=stringGets the deviceId of a claimed device by its trackingId.
  • DELETEUnclaims a device/registry/v2/:trackingId?appId=stringUnclaims a device removing the ownership association between the user and the device. The device data will no longer be accessible to the user. The device can…
  • POSTGets all resources of a resource type/registry/v4/resources/:resourceType/find?pageToken=string&limit=100&projectId=stringGets all resources of the resource type resourceType.

Aliases

  • GETGets all aliases/aliases/v2?type=string&externalId=string&pageToken=string&count=100&after=0.0&projectId=stringGets all aliases of a project. If type query parameter is provided, the response will contain only aliases of the given type. If externalId query parameter is…
  • GETGets service health/aliases/v2/health
  • GETGets the tracking ID associated with an alias/aliases/v2/trackingId?type=string&externalId=string&projectId=stringGets the trackingId associated with an alias.
  • GETGets service version/aliases/v2/version
  • GETGets all aliases of a device/aliases/v2/:trackingId?appId=string&pageToken=string&count=100&type=stringGets all aliases of a device identified by the trackingId. If the request is supplied with a type query parameter, the response will contain only aliases of…
  • DELETEDeletes all aliases of a device/aliases/v2/:trackingId?appId=stringDeletes all aliases of a device identified by the trackingId. Note that one needs to supply an HTTP header x-confirm with the value true to force the…
  • PUTCreates multiple aliases for a device/aliases/v2/:trackingId/batch?appId=stringCreates a set of aliases for a device identified by the trackingId. An alias must be unique within a project.
  • GETGets all aliases of a specified type for a device/aliases/v2/:trackingId/:type?appId=string&pageToken=string&count=100Gets all aliases of a specified type for a device identified by the trackingId.
  • DELETEDeletes all aliases of a specified type for a device/aliases/v2/:trackingId/:type?appId=stringDeletes all aliases of a specified type for a device identified by the trackingId. Note that one needs to supply an HTTP header x-confirm with the value true…
  • PUTCreates an alias/aliases/v2/:trackingId/:type/:externalId?appId=stringCreates an alias for the trackingId. An alias must be unique within a project.
  • DELETEDeletes an alias/aliases/v2/:trackingId/:type/:externalId?appId=stringDeletes the specified alias.

Associations

  • PUTUpdates rules associations for devices/associations/v3/devices/batchUpdate?appId=stringUpdates rules associated with devices.
  • POSTAssociates rules with a device/associations/v3/devices/:trackingId/batchCreate?appId=stringAssociates rules with the device trackingId.
  • POSTDisassociates rules from a device/associations/v3/devices/:trackingId/batchDelete?appId=stringDisassociates rules from the device identified by trackingId.
  • GETGets all devices associated with a geofence/associations/v3/geofences/:geofenceId?pageToken=string&count=100Gets all devices associated with the geofence geofenceId.
  • GETGets service health/associations/v3/health
  • GETGets all devices associated with a rule/associations/v3/rules/:ruleId?pageToken=string&count=100Gets all devices associated with the rule ruleId.
  • GETGets all devices associated with a sensor rule/associations/v3/sensors/:sensorRuleId?pageToken=string&count=100Gets all devices associated with the sensor rule sensorRuleId.
  • GETGets service version/associations/v3/version
  • GETGets geofences associated with a device/associations/v3/:trackingId/geofences?appId=string&pageToken=string&count=100&type=circleGets a list of geofences associated with the device trackingId.
  • PUTAssociates a device to a geofence/associations/v3/:trackingId/geofences/:geofenceId?appId=stringAssociates the device with trackingId to the geofence with geofenceId. Whenever the device enters or exits the associated geofence, an event is generated.
  • DELETEDisassociates a device and a geofence/associations/v3/:trackingId/geofences/:geofenceId?appId=stringDeletes an association between the geofence geofenceId and the device trackingId.
  • GETGets rules associated with a device/associations/v3/:trackingId/rules?appId=string&pageToken=string&count=100Gets a list of rules associated with the device trackingId.
  • PUTAssociates a device to a rule/associations/v3/:trackingId/rules/:ruleId?appId=stringAssociates the device with trackingId to the rule with ruleId. Whenever the device behaviour triggers the rule, an event is generated.
  • DELETEDisassociates a device and a rule/associations/v3/:trackingId/rules/:ruleId?appId=stringDeletes an association between the rule ruleId and the device trackingId.
  • GETGets sensor rules associated with a device/associations/v3/:trackingId/sensors?appId=string&pageToken=string&count=100Gets a list of sensor rules associated with the device trackingId.
  • PUTAssociates a device with a sensor rule/associations/v3/:trackingId/sensors/:sensorRuleId?appId=stringAssociates the device with trackingId to the sensor rule with sensorRuleId. A single device can only have one sensor rule per sensor type associated. The…
  • DELETEDisassociates a device and a sensor rule/associations/v3/:trackingId/sensors/:sensorRuleId?appId=stringDeletes the association between the sensor rule sensorRuleId and the device trackingId.

Bulk jobs

  • GETGets the bulk upload job IDs for a project/bulkjobs/v4/deviceUploads?projectId=string&pageToken=string&limit=100&type=create&status=pendingGets the bulk upload job IDs for a project. The jobs and their results are available for one week.
  • POSTStarts bulk upload/bulkjobs/v4/deviceUploads?projectId=string&fileName=stringStarts bulk upload process
  • PATCHUpdates bulk upload job status/bulkjobs/v4/deviceUploads/:jobId?projectId=stringUpdates bulk upload status. In case current status is pending or ongoing, user can perform action cancel, which cancels the bulk upload processes of the job…
  • GETGets bulk upload results/bulkjobs/v4/deviceUploads/:jobId/results?projectId=string&pageToken=string&limit=100Gets bulk upload results
  • GETGets bulk upload status/bulkjobs/v4/deviceUploads/:jobId/status?projectId=stringGets bulk upload status and progress
  • GETGets service health/bulkjobs/v4/health
  • GETGets service version/bulkjobs/v4/version

C2C

  • POSTReceives external device update reports/c2c/v4/callback?apiKey=stringExternal clouds can call this endpoint through their callback mechanism to report device updates. The format of the payload is driver specific.
  • GETGets a list of connectors/c2c/v4/connectors?projectId=string&pageToken=string&limit=100Gets a list of cloud-to-cloud connectors for the project projectId.
  • POSTCreates a connector/c2c/v4/connectors?projectId=stringRegisters a cloud-to-cloud connector between the HERE Tracking project projectId and an external cloud using the cloud-to-cloud driver driverId and the…
  • GETGets connector identifiers for an external device/c2c/v4/connectors/ext-devices/:externalDeviceId?projectId=stringGets identifiers for connectors to which an external device belongs.
  • GETGets a connector info/c2c/v4/connectors/:connectorIdGets connector info for the connector connectorId.
  • PUTUpdates a connector info/c2c/v4/connectors/:connectorIdUpdates the connector connectorId info.
  • DELETEDeletes a connector/c2c/v4/connectors/:connectorId?deleteDevices=trueDeletes the connector connectorId.
  • GETGets all external devices under a connector/c2c/v4/connectors/:connectorId/ext-devices?pageToken=string&limit=100Gets all external devices under the connector connectorId.
  • POSTAdds external devices to a connector/c2c/v4/connectors/:connectorId/ext-devicesAdds external devices to the connector connectorId.
  • DELETERemoves a batch of external devices from a connector/c2c/v4/connectors/:connectorId/ext-devices-batchRemoves a batch of external devices from the connector connectorId.
  • DELETERemoves an external device from a connector/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceIdRemoves the external device externalDeviceId from the connector connectorId.
  • GETGets a list of drivers/c2c/v4/drivers?pageToken=string&limit=100Gets all cloud-to-cloud drivers that a user is authorized to use.
  • POSTValidate and verify external cloud credentials for driver/c2c/v4/drivers/:driverId/verifyExternal cloud credentials to be validated for structure and fields provided. Verify external cloud authentication status.
  • GETGets service health/c2c/v4/health
  • GETGets service version/c2c/v4/version

Device Associations

  • GETGets service health/device-associations/v2/healthDeprecated.
  • GETGets service version/device-associations/v2/versionDeprecated.
  • GETGets geofences associated with a device/device-associations/v2/:trackingId/geofences?pageToken=string&count=100&appId=stringDeprecated. Gets all geofences associated with the device with trackingId.

Events

  • GETGets event history/events/v3?projectId=string&before=1.0&after=0.0&eventSource=attach&eventType=BELOW_RANGE&ruleId=3fa85f64-5717-4562-b3fc-2c963f66afa6&initialState=true&pageToken=string&count=1000&appId=stringGets all events for all devices and shipments of the project. The results are listed in descending order based on the timestamp. An event is uniquely…
  • GETGets service health/events/v3/health
  • GETGets the event statuses/events/v3/statuses?projectId=string&eventSource=attach&eventType=BELOW_RANGE&trackingId=string&ruleId=3fa85f64-5717-4562-b3fc-2c963f66afa6&geofenceId=3fa85f64-5717-4562-b3fc-2c963f66afa6&shipments=true&before=1.0&after=0.0&pageToken=string&count=1000&appId=stringGets all events statuses for all devices and shipments of the project. An event status of a device is the most recent event of any rule or geofence the device…
  • GETGets the number of devices and shipments in each event state/events/v3/statuses/deviceCounts?projectId=string&groupBy=ruleId&eventSource=attach&trackingId=string&ruleId=3fa85f64-5717-4562-b3fc-2c963f66afa6&geofenceId=3fa85f64-5717-4562-b3fc-2c963f66afa6&shipments=true&pageToken=string&count=1000&appId=stringThis API call counts the number of devices and shipments that are currently in the different event states per rule or per event source (that is per rule…
  • GETGets service version/events/v3/version
  • GETGets event history for a device or a shipment/events/v3/:trackingId?before=1.0&after=0.0&eventSource=attach&eventType=BELOW_RANGE&ruleId=3fa85f64-5717-4562-b3fc-2c963f66afa6&initialState=true&pageToken=string&count=1000&appId=stringGets 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…

Geofence Associations

  • GETGets service health/geofence-associations/v2/healthDeprecated.
  • GETGets service version/geofence-associations/v2/versionDeprecated.
  • GETGets all devices associated with a geofence/geofence-associations/v2/:geofenceId/devices?pageToken=string&count=100Deprecated. Returns all devices associated with the geofence geofenceId.
  • PUTAssociates a device with a geofence/geofence-associations/v2/:geofenceId/:trackingId?appId=stringDeprecated. Associates the device with trackingId to the geofence with geofenceId. Whenever the device enters or exits the associated geofence, an event is…
  • DELETEDisassociates a device and a geofence/geofence-associations/v2/:geofenceId/:trackingId?appId=stringDeprecated. Deletes an association between the geofence geofenceId and the device trackingId.

Geofences

  • GETGets all geofences/geofences/v2?projectId=string&pageToken=string&count=100&floor={"id":"DM_1234"}&type=circle&bbox=0.0&fields=stringGets all geofences of a project. Results can be filtered by using the query parameters. Indoor geofences with the floor properties may be filtered by…
  • POSTCreates a geofence/geofences/v2?projectId=stringOne can specify a geofence as a circle, as a polygon or as POI (Point of Interest). One can also assign a name and a description to each geofence to help…
  • DELETEDeletes all geofences/geofences/v2?projectId=stringDeletes all geofences of a project. If a geofence is associated with a stock rule, the rule will also be deleted. Note that one needs to supply an HTTP header…
  • GETGets service health/geofences/v2/health
  • POSTChecks if a POI geofence training is possible with the given parameters/geofences/v2/trainingTestChecks if a POI geofence training is possible with the given request parameters. The request body contains a training data sample in form of either a device…
  • GETGets service version/geofences/v2/version
  • GETGets a single geofence/geofences/v2/:geofenceId?fields=stringGets details of a single geofence identified by the geofenceId.
  • PUTUpdates a single geofence/geofences/v2/:geofenceIdUpdates the geofence type, name, description or definition property. The old geofence will be replaced by the new one, and hence the full set of the geofence…
  • DELETEDeletes a geofence/geofences/v2/:geofenceIdDeletes a single geofence identified by the geofenceId.
  • POSTTrains a POI geofence/geofences/v2/:geofenceId/poiTrainingTrains the POI geofence geofenceId using a device telemetry. The POI geofence boundary is defined using radio measurements. The geofence is trained using a…

Labels

  • GETGets service health/labels/v4/health
  • GETGets service version/labels/v4/version
  • GETGets all labels of a resource type/labels/v4/:resourceType?projectId=string&labels={"group":"group1","priority":"high"}&pageToken=string&limit=100&fields=stringGets all labels of the resource type resourceType within a project. The fields parameter specifies which fields should be added to the response body (for…
  • GETGets all label keys of a resource type/labels/v4/:resourceType/keys?projectId=stringGets all label keys of the resource type resourceType.
  • GETGets all values of a label/labels/v4/:resourceType/keys/:key/values?projectId=stringGets all values of the label key for the resource type resourceType.
  • GETGets all labels of a resource/labels/v4/:resourceType/:resourceId?appId=string&fields=stringGets all labels of the resource resourceId.
  • DELETEDeletes all labels of a resource/labels/v4/:resourceType/:resourceId?appId=stringDeletes all labels of the resource resourceId.
  • PUTCreates a set of labels for a resource/labels/v4/:resourceType/:resourceId/batch?appId=stringCreates a set of labels for the resource resourceId.
  • DELETEDeletes all labels of a resource by a label key/labels/v4/:resourceType/:resourceId/:key?appId=stringDeletes all the labels that have the key key of the resource resourceId.
  • PUTCreates a label for a resource/labels/v4/:resourceType/:resourceId/:key/:value?appId=stringCreates a label for the resource resourceId.
  • DELETEDeletes a label of a resource/labels/v4/:resourceType/:resourceId/:key/:value?appId=stringDeletes the label key-value of the resource resourceId.

Locations

  • GETGets all locations/locations/v4?projectId=string&limit=100&pageToken=string&geofenceId=3fa85f64-5717-4562-b3fc-2c963f66afa6&name=*office*&street=*street*&city=*city*&postalCode=*100*&state=New*&country=*land*&locationId=LOC-*&sort=name:asc&externalLocationId=stringGets all locations of the project.
  • POSTCreates a location/locations/v4?projectId=stringCreates a new location. A location consists of latitude/longitude coordinate pair and/or geofenceId. A name, description, and address of the location may be…
  • DELETEDeletes all locations/locations/v4?projectId=stringDeletes all locations of the project. Note that one needs to supply an HTTP header x-confirm with the value true to force the deletion. If the header is not…
  • GETGets service health/locations/v4/health
  • GETGets service version/locations/v4/version
  • GETGets a location details/locations/v4/:locationIdGets details of the location locationId.
  • PUTUpdates a location details/locations/v4/:locationIdUpdates the location locationId details. A location consists of latitude/longitude coordinate pair and/or geofenceId. A name, description, and address of the…
  • DELETEDeletes a location/locations/v4/:locationIdDeletes the location locationId. *NOTE*: A location can not be deleted if the location is referred by any shipment or shipment plan.

Metadata

  • POSTGets a batch of metadata of multiple devices or shipments/metadata/v2/devices/batch?pageToken=string&count=100Gets a batch of metadata of multiple devices or shipments. The device or shipment IDs are specified in the request body.
  • GETGets metadata of a device or a shipment/metadata/v2/devices/:trackingId?appId=stringGets metadata of a device or a shipment identified by the trackingId or the shipmentId.
  • PUTCreates or updates metadata of a device or a shipment/metadata/v2/devices/:trackingId?appId=stringUpdates the metadata object of the device or a shipment identified by the trackingId or the shipmentId. The metadata specified in the request body is merged…
  • DELETEDeletes all metadata of a device or a shipment/metadata/v2/devices/:trackingId?appId=stringDeletes all the metadata of the device or a shipment identified by the trackingId or the shipmentId.
  • POSTGets a batch of metadata of multiple geofences/metadata/v2/geofences/batch?pageToken=string&count=100Gets a batch of metadata of multiple geofences. The geofences IDs are specified in the request body.
  • GETGets metadata of a geofence/metadata/v2/geofences/:geofenceIdGets metadata of the geofence identified by the geofenceId.
  • PUTCreates or updates metadata of a geofence/metadata/v2/geofences/:geofenceIdUpdates the metadata object of the geofence identified by the geofenceId. The metadata specified in the request body is merged with the existing metadata…
  • DELETEDeletes all metadata of a geofence/metadata/v2/geofences/:geofenceIdDeletes all the metadata of the geofence identified by the geofenceId.
  • GETGets service health/metadata/v2/health
  • POSTGets a batch of metadata for multiple sensor rules/metadata/v2/sensorRules/batch?pageToken=string&count=100Gets a batch of metadata of multiple sensor rules. The sensor rules IDs are specified in the request body.
  • GETGets metadata of a sensor rule/metadata/v2/sensorRules/:sensorRuleIdGets metadata of the sensor rule identified by the sensorRuleId.
  • PUTCreates or updates metadata of a sensor rule/metadata/v2/sensorRules/:sensorRuleIdUpdates the metadata object of the sensor rule identified by the sensorRuleId. The metadata specified in the request body is merged with the existing metadata…
  • DELETEDeletes all metadata of a sensor rule/metadata/v2/sensorRules/:sensorRuleIdDelete all the metadata of the sensor rule identified by the sensorRuleId.
  • GETGets service version/metadata/v2/version

Notifications

  • GETGets service health/notifications/v3/health
  • GETGets a single notification channel information/notifications/v3/registration/:channelIdGets details of the notification channel channelId.
  • PUTUpdates a notification channel/notifications/v3/registration/:channelIdUpdates the url, ruleId, eventSource, eventType and initialState parameters of the notification channel channelId. If a property is not provided in the…
  • DELETEUnregisters from notifications/notifications/v3/registration/:channelIdUnregisters from notifications and deletes the notification channel channelId.
  • GETGets all registered notification channels/notifications/v3/registrations?pageToken=string&count=100&projectId=string&channelType=webhook&userId=string&emailBounce=trueGets a list of all registered notification channels.
  • POSTRegisters for notifications/notifications/v3/registrations?projectId=string&userId=stringUser can subscribe to notifications of all events triggered by device telemetry and rules and geofences. To get notified about some specific events only, one…
  • DELETEUnregisters from all notifications/notifications/v3/registrations?projectId=stringDeletes all the notification channels. This would result in unregistering from all the notifications. Note that one needs to supply an HTTP header x-confirm…
  • GETGets service version/notifications/v3/version

Reports

  • POSTStarts report creation/reports/v4?projectId=stringStarts a report creation. The request body contains a rule ID, and the report start and end time. The report will be created based on the event data generated…
  • GETGets service health/reports/v4/health
  • GETGets service version/reports/v4/version
  • GETGets reports/reports/v4/:reportId?projectId=string&pageToken=string&limit=100&measure=duration&interval=day&trackingId=string&geofenceId=3fa85f64-5717-4562-b3fc-2c963f66afa6&groupBy=asset&method=average&sort=timestamp:ascGets the report creation status and makes queries to fetch the actual reports. Each report request can have a different set of query parameters. > Note that…

Rules

  • GETGets all rules/rules/v4?projectId=string&pageToken=string&limit=100Gets all rules definitions.
  • POSTCreates a rule/rules/v4?projectId=stringCreates a rule of the specified rule type and with the defined threshold. After the rule has been created, it needs to be associated to a device to get…
  • DELETEDeletes all rules/rules/v4?projectId=stringDeletes all rules of the project. Note that one needs to supply an HTTP header x-confirm with the value true to force the deletion. If the header is not…
  • GETGets service health/rules/v4/health
  • GETGets service version/rules/v4/version
  • GETGets a single rule/rules/v4/:ruleIdGets details of a single rule identified by the ruleId.
  • PUTUpdates a single rule/rules/v4/:ruleIdUpdates the name, description and threshold of the rule ruleId. The rule type cannot be updated. If some of the these properties are not provided in the…
  • DELETEDeletes a rule/rules/v4/:ruleIdDeletes a rule identified by the ruleId.

Sensors

  • GETGets all sensor rules/sensors/v3?projectId=string&pageToken=string&count=100Gets all sensor rules definitions.
  • POSTCreates a sensor rule/sensors/v3?projectId=stringCreates a sensor rule of the specified rule type. After the sensor rule has been created, it needs to be associated to a device to get activated. For a sensor…
  • DELETEDeletes all sensor rules/sensors/v3?projectId=stringDeletes all sensor rules of a project. Note that one needs to supply an HTTP header x-confirm with the value true to force the deletion. If the header is not…
  • GETGets service health/sensors/v3/health
  • GETGets service version/sensors/v3/version
  • GETGets a single sensor rule/sensors/v3/:sensorRuleIdGets details of a single sensor rule identified by the sensorRuleId.
  • PUTUpdates a single sensor rule/sensors/v3/:sensorRuleIdUpdates the sensor rule sensorRuleId name, description and range or threshold. The sensor rule type cannot be updated. If some of the these properties are not…
  • DELETEDeletes a sensor rule/sensors/v3/:sensorRuleIdDeletes a sensor rule identified by the sensorRuleId.

Shadows

  • POSTGets a batch of device shadows/shadows/v2/batch?after=0.0&appId=stringGets device shadows for multiple devices. One can get shadows for a maximum of 100 devices per request. In case after parameter is provided, only the device…
  • GETGets service health/shadows/v2/health
  • GETGets service version/shadows/v2/version
  • GETGets a device shadow/shadows/v2/:trackingId?appId=stringGets the trackingId device shadow that contains both reported and desired shadows. If a shipmentId is used instead of a trackingId, it will return a shadow of…
  • PUTUpdates a device shadow/shadows/v2/:trackingId?appId=stringUpdates the trackingId device desired shadow. The device shadow consists of reported and desired shadows. Only the desired shadow can be updated via this…
  • DELETEClears a device shadow/shadows/v2/:trackingId?appId=string&desired=true&reported=trueDeletes the device shadow of the trackingId device. By default, all the values of the desired and reported shadow objects will be cleared, leaving them empty.…
  • GETGets reported or desired state object of a device/shadows/v2/:trackingId/:state?appId=stringGets the reported or desired state object of the device trackingId, that is the reported or desired device shadow.
  • GETGets a value of a shadow property/shadows/v2/:trackingId/:state/:selector?appId=stringGets 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…
  • GETGets all shadows/shadows/v4?projectId=string&pageToken=string&limit=100&after=2024-01-01T00:00:00Z&sort=reported.timestamp:desc&bbox=61.494750,23.775189,61.494611,23.774758Gets all device shadows of a project.

Shipment Reports

  • POSTStarts shipment report generation/shipment-reports/v4?projectId=stringThis endpoint starts the shipment report generation. One can specify which shipments to include in the shipments report by using the filters in the request…
  • GETGets service health/shipment-reports/v4/health
  • GETGets service version/shipment-reports/v4/version
  • GETGets status of generation of the shipment report/shipment-reports/v4/:shipmentReportId/statusUse the shipmentReportId as a path parameter for fetching the status of the generation of the shipment report.
  • GETGets summary of the shipment report/shipment-reports/v4/:shipmentReportId/summaryAfter the shipment report generation is completed, use the shipmentReportId as a path parameter for fetching the summary of the shipment report. The summary…
  • GETGets metrics of the shipment report/shipment-reports/v4/:shipmentReportId/:metric?pageToken=string&limit=100&sort=stringGet the shipment report metric by using the shipmentReportId and a metric parameters. Shipment report metrics can be requested only after the shipment report…

Shipments

  • GETGets all shipments/shipments/v4?projectId=string&pageToken=string&limit=100&status=pending&startedBefore=2024-01-01T00:00:00Z&startedAfter=2024-01-01T00:00:00Z&endedBefore=2024-01-01T00:00:00Z&endedAfter=2024-01-01T00:00:00Z&name=*portugal*&shipmentPlanId=string&shipmentId=string&isSubShipment=true&createdBefore=2024-01-01T00:00:00Z&createdAfter=2024-01-01T00:00:00Z&sort=name:ascGets all shipments of the project.
  • POSTCreates a shipment/shipments/v4?projectId=stringCreates a new shipment. A shipment consists of segments each representing a part of the logistics journey. A segment spans from a location to another and each…
  • DELETEDeletes all shipments/shipments/v4?projectId=stringDeletes all the shipments of the project. Note that one needs to supply an HTTP header x-confirm with the value true to force the deletion. If the header is…
  • GETGets service health/shipments/v4/health
  • GETLists all shipment plans/shipments/v4/plans?projectId=string&pageToken=string&limit=100&name=*portugal*&shipmentPlanId=string&locationId=string&createdBefore=2024-01-01T00:00:00Z&createdAfter=2024-01-01T00:00:00Z&isSubShipment=true&sort=name:ascGets all shipment plans of the project.
  • POSTCreates a shipment plan/shipments/v4/plans?projectId=stringCreates a new shipment plan. A shipment plan is a structure that holds information about a recurring shipment. Like a shipment, a shipment plan also consists…
  • DELETEDeletes all shipment plans/shipments/v4/plans?projectId=stringDeletes all shipment plans of the project. Any shipments instantiated from the plans will persist, but the references to the parent plans will be removed.…
  • GETGets a shipment plan details/shipments/v4/plans/:shipmentPlanIdGets details of a shipment plan identified by the shipmentPlanId.
  • DELETEDeletes a shipment plan/shipments/v4/plans/:shipmentPlanIdDeletes a shipment plan identified by the shipmentPlanId. Any shipment instantiated from the plan will persist, but the reference to the parent plan will be…
  • PATCHUpdates a shipment plan details/shipments/v4/plans/:shipmentPlanIdUpdates details of a shipment plan identified by the shipmentPlanId. This is a partial update, meaning that only the provided fields will be updated. If…
  • GETGets a segment plan details/shipments/v4/plans/:shipmentPlanId/:segmentPlanIdGets details of a segment plan identified by the segmentPlanId.
  • PATCHUpdates a segment plan details/shipments/v4/plans/:shipmentPlanId/:segmentPlanIdUpdates details of a segment plan identified by the segmentPlanId. This is a partial update, meaning that only the provided fields will be updated. *Note*:…
  • GETGets service version/shipments/v4/version
  • GETGets a shipment details/shipments/v4/:shipmentIdGets details of a specific shipment identified by the shipmentId.
  • DELETEDeletes a shipment/shipments/v4/:shipmentIdDeletes a shipment identified by the shipmentId. All the data related to the shipment (such as events, associations) will be removed.
  • PATCHUpdates a shipment details/shipments/v4/:shipmentIdUpdates details of a shipment identified by the shipmentId. This is a partial update, meaning that only the provided fields will be updated, except when…
  • GETGets a segment details/shipments/v4/:shipmentId/:segmentIdGets details of a segment identified by the segmentId.
  • PATCHUpdates a segment details/shipments/v4/:shipmentId/:segmentIdUpdates details of a segment identified by the segmentId. This is a partial update, meaning that only the provided fields will be updated. Changing the status…
  • GETGets segments assigned to a device/shipments/v4/:trackingId/segments?pageToken=string&limit=100&status=pendingGets all segments that are assigned to the device with trackingId or shipmentId.

Traces

  • GETGets service health/traces/v2/health
  • GETGets service version/traces/v2/version
  • GETGets traces within a specified time range/traces/v2/:trackingId?appId=string&before=1.0&after=0.0&outliers=true&mode=unknown&smooth=true&pageToken=string&count=1000Gets all traces of the device trackingId that were recorded within the specified time range. The range is defined with before and after parameters. The…
  • DELETEDeletes all the device traces and events/traces/v2/:trackingId?appId=stringDeletes all the device trackingId traces. This will also trigger deletion of the entire event history of the device.

Transitions

  • GETGets transitions for a device/transitions/v2/devices/:trackingId?appId=string&before=1.0&after=0.0&pageToken=string&count=100Deprecated. Gets all transitions that were recorded within a specific time range. Define the range with before and after parameters. The returned transitions…
  • GETGets service health/transitions/v2/healthDeprecated.
  • GETGets service version/transitions/v2/versionDeprecated.

Users

  • GETGets all devices claimed by a project/users/v2/devices?projectId=string&pageToken=string&count=100Gets all devices claimed by a project.
  • GETGets service health/users/v2/health
  • POSTGets a user access token/users/v2/loginAuthenticates a user with an email and a password and gets a user access token upon the successful authentication. The user email must be registered with a…
  • POSTGets a renewed user access token/users/v2/refreshGets a new valid user access token for a given previous access token and a refresh token.
  • POSTGets a project-scoped user access token/users/v2/tokenExchangeTakes user access token, requested scope and returns project-scoped user access token.
  • GETGets service version/users/v2/version

API details

Base URL
https://tracking.api.here.com
Authentication
A bearer token in the Authorization header
HTTP oauth authentication
Operations
216 operations on 159 pathsGET 121DELETE 35POST 34PUT 21PATCH 5
11 marked deprecated
Main resources
Shipments 19Associations 17C2C 15Registry 15Metadata 14Aliases 11Labels 11Geofences 10Largedata 10Ingestion 9
Response formats
application/json application/octet-stream text/plain
Description format
OpenAPI 3.0.0, API version 2.1.191
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the HERE Tracking in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the HERE Tracking collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Ingests data and receives a shadow” (POST /v2/?async=false), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the HERE Tracking?

HERE Tracking is a cloud product designed to address location tracking problems for a wide range of Location IoT industry verticals. HERE Tracking also… It is listed under Maps & location and has 216 endpoints.

Who publishes the HERE Tracking?

It is listed from Here's public API description (an OpenAPI document), not published by Here on Swastik Codes. Anyone who controls here.com can claim the profile by adding a DNS TXT record.

What is the base URL of the HERE Tracking?

Requests go to https://tracking.api.here.com. Endpoint paths are added to this base URL.

How do I authenticate with the HERE Tracking?

It accepts 2 methods: A bearer token in the Authorization header; HTTP oauth authentication.

How many endpoints does the HERE Tracking have?

216 operations on 159 paths (121 GET, 35 DELETE, 34 POST, 21 PUT, 5 PATCH). The largest groups are Shipments, Associations, C2C, Registry.

Is forking the HERE Tracking free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.