HERE

HERE Sensors API

The Sensors service creates and manages sensor rules. The sensor rules generate events and notifications when get triggered by a reported device sensor reading. The following sensor rule types are supported: * battery * humidity * pressure * temperature * acceleration * attach * tamper After a sensor rule has been created, it needs to be associated to a device to get activated. This association means that every time a sensor update is received from the device as a part of its ingestion telemetry, it will be evaluated against the sensor rule condition. As soon as the evaluation changes (for example, from true to false), an event will be recorded.

Documentation GitHub OpenAPI

Operations 8

GET /sensors/v3/health Gets service health #

GET /sensors/v3/version Gets service version #

POST /sensors/v3 Creates a sensor rule #

GET /sensors/v3 Gets all sensor rules #

DELETE /sensors/v3 Deletes all sensor rules #

GET /sensors/v3/{sensorRuleId} Gets a single sensor rule #

PUT /sensors/v3/{sensorRuleId} Updates a single sensor rule #

DELETE /sensors/v3/{sensorRuleId} Deletes a sensor rule #

Documentation

https://docs.here.com/identity-and-access-management/docs

https://docs.here.com/identity-and-access-management/reference

https://docs.here.com/data-api/docs

https://docs.here.com/data-api/reference

https://docs.here.com/usage/docs

https://docs.here.com/usage/reference

https://docs.here.com/destination-weather/docs

https://docs.here.com/destination-weather/reference

https://docs.here.com/ev-products/docs

https://docs.here.com/ev-products/reference

https://docs.here.com/fuel-prices/docs

https://docs.here.com/fuel-prices/reference

https://docs.here.com/geocoding-and-search/docs

https://docs.here.com/geocoding-and-search/reference

https://docs.here.com/routing/docs

https://docs.here.com/routing/reference

https://docs.here.com/positioning/docs

https://docs.here.com/positioning/reference

https://docs.here.com/indoor-map/docs

https://docs.here.com/indoor-map/reference

https://docs.here.com/transit/docs

https://docs.here.com/transit/reference

https://docs.here.com/map-attributes/docs

https://docs.here.com/map-attributes/reference

https://docs.here.com/map-rendering/docs

https://docs.here.com/map-rendering/reference

https://docs.here.com/workspace/docs

https://docs.here.com/workspace/reference

https://docs.here.com/tour-planning/docs

https://docs.here.com/tour-planning/reference

https://docs.here.com/tracking/docs

https://docs.here.com/tracking/reference

https://docs.here.com/traffic-api/docs

https://docs.here.com/traffic-api/reference

https://docs.here.com/wego-pro/docs

https://docs.here.com/wego-pro/reference

Specifications

https://raw.githubusercontent.com/api-evangelist/here/refs/heads/main/openapi/here-sensors-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/here-sensors-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  version: 2.6.11
  title: HERE Tracking Sensors API
  description: '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.'
  license:
    name: HERE Documentation License
    url: https://legal.here.com/en-gb/terms/documentation-license
servers:
- url: https://tracking.hereapi.com/
- url: https://tracking.api.here.com/
tags:
- description: The Sensors service creates and manages sensor rules.
  name: Sensors
paths:
  /sensors/v3/health:
    get:
      summary: Gets service health
      security: []
      responses:
        '200':
          description: 'OK


            The service is performing as expected

            '
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: Health status
                example:
                  message: healthy
        '500':
          description: 'Service unavailable


            The service is not performing as expected

            '
      tags:
      - Sensors
      operationId: getSensorsV3Health
      x-operation-id-source: derived
  /sensors/v3/version:
    get:
      summary: Gets service version
      security: []
      responses:
        '200':
          description: 'Success

            '
          content:
            application/json:
              schema:
                description: "OK\nService returns its current version number\nschema:\n    type: object\n    properties:\n        \"service-name\":\n            type: string\n            description: Version of service\n    example:\n        servicename: \"1.0.0\"\n"
        '500':
          description: 'Service unavailable


            The service is not performing as expected

            '
      tags:
      - Sensors
      operationId: getSensorsV3Version
      x-operation-id-source: derived
  /sensors/v3:
    parameters:
    - in: header
      name: X-Request-Id
      schema:
        type: string
        format: uuid
      description: 'ID used for correlating requests within HERE Tracking. Used for logging and error reporting.


        Must be a valid UUIDv4.

        '
      required: false
    - name: projectId
      schema:
        type: string
        minLength: 1
        maxLength: 50
        description: 'Project ID.

          Any HERE Tracking user must be a member of a Tracking project.

          The project ID can be implicitly resolved if the user calling the API is a member of a single project.

          If the user is a member of multiple projects, the `projectId` query parameter needs to be specified explicitly.

          '
      in: query
      required: false
    post:
      summary: Creates a sensor rule
      description: 'Creates 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 rule of the battery, humidity, pressure and temperature type, a `range` parameter needs

        to be specified, defining both upper and lower thresholds for the sensor readings.

        When the device ingests data, the reported sensor reading is compared to the defined range

        and in case in or out of range transition has taken place, an event gets triggered.


        For a sensor rule of the acceleration type, a `threshold` parameter needs

        to be specified, defining the acceleration threshold value.

        Every time the device reports its accelerometer sensor reading being above the threshold,

        an event gets triggered.


        For a sensor rule of the attach and tamper types, no additional parameters

        need to be specified.

        The attach sensor detects whether the device is attached to some object (for example to an

        asset).

        The tamper sensor detects whether the device cover is open or closed. When the cover is open,

        the device is considered to be tampered with.

        Every time the device reports getting attached, detached, tampered with or left with the

        cover closed (that is, not tampered with), an event gets triggered.


        When a sensor rule has been successfully created, the response body will contain the created rule ID.'
      security:
      - UserToken: []
      - ClientToken: []
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - title: Battery
                type: object
                properties:
                  type:
                    type: string
                    description: The sensor type.
                    enum:
                    - battery
                  range:
                    type: object
                    properties:
                      begin:
                        type: number
                        description: A minimum battery sensor alarm threshold value. Must be less than end.
                        minimum: 0
                        maximum: 100
                      end:
                        type: number
                        description: A maximum battery sensor alarm threshold value. Must be greater than begin.
                        minimum: 0
                        maximum: 100
                    required:
                    - begin
                    - end
                    additionalProperties: false
                  name:
                    type: string
                    maxLength: 50
                    description: Sensor rule name
                  description:
                    type: string
                    maxLength: 1000
                    description: Sensor rule description
                required:
                - type
                - range
                additionalProperties: false
              - title: Humidity
                type: object
                properties:
                  type:
                    type: string
                    description: The sensor type.
                    enum:
                    - humidity
                  range:
                    type: object
                    properties:
                      begin:
                        type: number
                        description: A minimum humidity sensor alarm threshold value. Must be less than end.
                        minimum: 0
                        maximum: 100
                      end:
                        type: number
                        description: A maximum humidity sensor alarm threshold value. Must be greater than begin.
                        minimum: 0
                        maximum: 100
                    required:
                    - begin
                    - end
                    additionalProperties: false
                  name:
                    type: string
                    maxLength: 50
                    description: Sensor rule name
                  description:
                    type: string
                    maxLength: 1000
                    description: Sensor rule description
                required:
                - type
                - range
                additionalProperties: false
              - title: Pressure
                type: object
                properties:
                  type:
                    type: string
                    description: The sensor type.
                    enum:
                    - pressure
                  range:
                    type: object
                    properties:
                      begin:
                        type: number
                        description: A minimum pressure sensor alarm threshold value. Must be less than end.
                        minimum: 300
                        maximum: 1500
                      end:
                        type: number
                        description: A maximum pressure sensor alarm threshold value. Must be greater than begin.
                        minimum: 300
                        maximum: 1500
                    required:
                    - begin
                    - end
                    additionalProperties: false
                  name:
                    type: string
                    maxLength: 50
                    description: Sensor rule name
                  description:
                    type: string
                    maxLength: 1000
                    description: Sensor rule description
                required:
                - type
                - range
                additionalProperties: false
              - title: Temperature
                type: object
                properties:
                  type:
                    type: string
                    description: The sensor type.
                    enum:
                    - temperature
                  range:
                    type: object
                    properties:
                      begin:
                        type: number
                        description: A minimum temperature sensor alarm threshold value. Must be less than end.
                        minimum: -70
                        maximum: 100
                      end:
                        type: number
                        description: A maximum temperature sensor alarm threshold value. Must be greater than begin.
                        minimum: -70
                        maximum: 100
                    required:
                    - begin
                    - end
                    additionalProperties: false
                  name:
                    type: string
                    maxLength: 50
                    description: Sensor rule name
                  description:
                    type: string
                    maxLength: 1000
                    description: Sensor rule description
                required:
                - type
                - range
                additionalProperties: false
              - title: Boolean
                type: object
                properties:
                  type:
                    type: string
                    description: The sensor type.
                    enum:
                    - attach
                    - tamper
                  name:
                    type: string
                    maxLength: 50
                    description: Sensor rule name
                  description:
                    type: string
                    maxLength: 1000
                    description: Sensor rule description
                required:
                - type
                additionalProperties: false
              - title: Acceleration
                type: object
                properties:
                  type:
                    type: string
                    description: The sensor type.
                    enum:
                    - acceleration
                  threshold:
                    type: object
                    properties:
                      value:
                        type: number
                        description: An acceleration sensor alarm threshold value.
                        minimum: 2
                        maximum: 100
                    required:
                    - value
                    additionalProperties: false
                  name:
                    type: string
                    maxLength: 50
                    description: Sensor rule name
                  description:
                    type: string
                    maxLength: 1000
                    description: Sensor rule description
                required:
                - type
                - threshold
                additionalProperties: false
      tags:
      - Sensors
      responses:
        '201':
          description: 'Created


            The sensor rule was successfully created.

            '
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: Set to `created` if the sensor rule creation was successful.
                  id:
                    type: string
                    format: uuid
                    description: 'Must be a valid UUIDv4.

                      '
                required:
                - id
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: An HTTP error description
                  code:
                    type: integer
                    description: An HTTP status code
                  message:
                    type: string
                    description: Descriptive text that explains the error
                  id:
                    type: string
                    format: uuid
                    description: An error ID that allows you to trace the error details
                  details:
                    description: An optional object containing more information about the error
                required:
                - error
                - code
                - id
              example:
                error: Bad request
                code: 400
                id: 5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2
                message: The request object is in an incorrect format or has values that are invalid or out of range.
                details:
                  hereErrorCode: 400306
          description: 'Bad 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.

            '
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: An HTTP error description
                  code:
                    type: integer
                    description: An HTTP status code
                  message:
                    type: string
                    description: Descriptive text that explains the error
                  id:
                    type: string
                    format: uuid
                    description: An error ID that allows you to trace the error details
                  details:
                    description: An optional object containing more information about the error
                required:
                - error
                - code
                - id
              example:
                error: Unauthorized
                code: 401
                id: 5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2
                message: The provided credentials are not valid.
                details:
                  hereErrorCode: 401306
          description: 'Unauthorized


            The request did not provide correct authentication details

            '
        '403':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: An HTTP error description
                  code:
                    type: integer
                    description: An HTTP status code
                  message:
                    type: string
                    description: Descriptive text that explains the error
                  id:
                    type: string
                    format: uuid
                    description: An error ID that allows you to trace the error details
                  details:
                    description: An optional object containing more information about the error
                required:
                - error
                - code
                - id
              example:
                error: Forbidden
                code: 403
                id: 5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2
                message: The account does not have the correct privileges.
                details:
                  hereErrorCode: 403306
          description: 'Forbidden


            The account does not have the correct privileges

            '
      operationId: postSensorsV3
      x-operation-id-source: derived
    get:
      summary: Gets all sensor rules
      description: Gets all sensor rules definitions.
      security:
      - UserToken: []
      - ClientToken: []
      parameters:
      - name: pageToken
        description: A token from the previously returned response to retrieve the specified page.
        schema:
          type: string
        in: query
        required: false
      - name: count
        description: The number of items to return per page.
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 100
        in: query
        required: false
      tags:
      - Sensors
      responses:
        '200':
          description: 'Response body contains an array of sensor rule objects, `count` indicates the number of returned sensor rules,

            and `pageToken` is the next page token if available.


            If no sensor rules are found, an object with an empty data array is returned.

            '
          content:
            application/json:
              example:
                data:
                - id: f4c26630-5d26-4cd1-a57e-g7834e72cb99
                  type: temperature
                  range:
                    begin: -20
                    end: 30
                - id: j7c24430-5f26-4kd1-c58e-g7126e72ab33
                  type: pressure
                  range:
                    begin: 30
                    end: 80
                pageToken: 024ggjjea253d79fc
                count: 2
              schema:
                type: object
                description: 'Response body contains an array of sensor rule objects, `count` indicates the number of returned sensor rules,

                  and `pageToken` is the next page token if available.


                  If no sensor rules are found, an object with an empty data array is returned.

                  '
                allOf:
                - type: object
                  properties:
                    pageToken:
                      type: string
                      description: A token that can be used to retrieve the next page of the response.
                    count:
                      type: integer
                      minimum: 0
                      maximum: 100
                      default: 100
                      description: The number of items in the response.
                - type: object
                  properties:
                    data:
                      type: array
                      items:
                        description: Response body contains a single sensor rule object
                        type: object
                        properties:
                          id:
                            type: string
                            format: uuid
                            description: 'Must be a valid UUIDv4.

                              '
                          type:
                            type: string
                            description: The sensor type.
                            enum:
                            - attach
                            - battery
                            - humidity
                            - pressure
                            - tamper
                            - temperature
                            - acceleration
                          range:
                            type: object
                            properties:
                              begin:
                                type: number
                                description: The lower threshold value.
                              end:
                                type: number
                                description: The upper threshold value.
                            required:
                            - begin
                            - end
                          threshold:
                            type: object
                            properties:
                              value:
                                type: number
                                description: Threshold value
                            required:
                            - value
                          name:
                            type: string
                          description:
                            type: string
                        required:
                        - id
                        - type
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: An HTTP error description
                  code:
                    type: integer
                    description: An HTTP status code
                  message:
                    type: string
                    description: Descriptive text that explains the error
                  id:
                    type: string
                    format: uuid
                    description: An error ID that allows you to trace the error details
                  details:
                    description: An optional object containing more information about the error
                required:
                - error
                - code
                - id
              example:
                error: Bad request
                code: 400
                id: 5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2
                message: The request object is in an incorrect format or has values that are invalid or out of range.
                details:
                  hereErrorCode: 400306
          description: 'Bad 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.

            '
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: An HTTP error description
                  code:
                    type: integer
                    description: An HTTP status code
                  message:
                    type: string
                    description: Descriptive text that explains the error
                  id:
                    type: string
                    format: uuid
                    description: An error ID that allows you to trace the error details
                  details:
                    description: An optional object containing more information about the error
                required:
                - error
                - code
                - id
              example:
                error: Unauthorized
                code: 401
                id: 5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2
                message: The provided credentials are not valid.
                details:
                  hereErrorCode: 401306
          description: 'Unauthorized


            The request did not provide correct authentication details

            '
        '403':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: An HTTP error description
                  code:
                    type: integer
                    description: An HTTP status code
                  message:
                    type: string
                    description: Descriptive text that explains the error
                  id:
                    type: string
                    format: uuid
                    description: An error ID that allows you to trace the error details
                  details:
                    description: An optional object containing more information about the error
                required:
                - error
                - code
                - id
              example:
                error: Forbidden
                code: 403
                id: 5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2
                message: The account does not have the correct privileges.
                details:
                  hereErrorCode: 403306
          description: 'Forbidden


            The account does not have the correct privileges

            '
      operationId: getSensorsV3
      x-operation-id-source: derived
    delete:
      summary: Deletes all sensor rules
      description: 'Deletes 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 provided, the request will fail.'
      security:
      - UserToken: []
      - ClientToken: []
      tags:
      - Sensors
      parameters:
      - schema:
          type: string
          enum:
          - 'true'
        in: header
        name: x-confirm
        required: true
        description: 'A safety measure that prevents one from accidentally deleting data.


          To confirm that all entries should be deleted, set the value to `true`.

          '
      responses:
        '204':
          description: 'Successful (no content)


            All sensor rules were successfully deleted.

            '
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: An HTTP error description
                  code:
                    type: integer
                    description: An HTTP status code
                  message:
                    type: string
                    description: Descriptive text that explains the error
                  id:
                    type: string
                    format: uuid
                    description: An error ID that allows you to trace the error details
                  details:
                    description: An optional object containing more information about the error
                required:
                - error
                - code
                - id
              example:
                error: Bad request
                code: 400
                id: 5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2
                message: The request object is in an incorrect format or has values that are invalid or out of range.
                details:
                  hereErrorCode: 400306
          description: 'Bad 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.

            '
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: An HTTP error description
                  code:
                    type: integer
                    description: An HTTP status code
                  message:
                    type: string
                    description: Descriptive text that explains the error
                  id:
                    type: string
                    format: uuid
                    description: An error ID that allows you to trace the error details
                  details:
                    description: An optional object containing more information about the error
                required:
                - error
                - code
                - id
              example:
                error: Unauthorized
                code: 401
                id: 5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2
                message: The provided credentials are not valid.
                details:
                  hereErrorCode: 401306
          description: 'Unauthorized


            The request did not provide correct authentication details

            '
        '403':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: An HTTP error description
                  code:
                    type: integer
                    description: An HTTP status code
                  message:
                    type: string
                    description: Descriptive text that explains the error
                  id:
                    type: string
                    format: uuid
                    description: An error ID that allows you to trace the error details
                  details:
                    description: An optional object containing more information about the error
                required:
                - error
                - code
                - id
              example:
                error: Forbidden
                code: 403
                id: 5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2
                message: The account does not have the correct privileges.
                details:
                  hereErrorCode: 403306
          description: 'Forbidden


            The account does not have the correct privileges

            '
      operationId: deleteSensorsV3
      x-operation-id-source: derived
  /sensors/v3/{sensorRuleId}:
    parameters:
    - in: header
      name: X-Request-Id
      schema:
        type: string
        format: uuid
      description: 'ID used for correlating requests within HERE Tracking. Used for logging and error reporting.


        Must be a valid UUIDv4.

        '
      required: false
    - in: path
      schema:
        type: string
        format: uuid
        description: 'Must be a valid UUIDv4.

          '
      name: sensorRuleId
      description: ID of the sensor rule
      required: true
    get:
      summary: Gets a single sensor rule
      description: Gets details of a single sensor rule identified by the `sensorRuleId`.
      security:
      - UserToken: []
      - ClientToken: []
      tags:
      - Sensors
      responses:
        '200':
          description: 'Response body contains a single sensor rule object.

            '
          content:
            application/json:
              example:
                id: f4c26630-5d26-4cd1-a57e-g7834e72cb99
                type: temperature
                range:
                  begin: -20
                  end: 30
              schema:
                description: Response body contains a single sensor rule object
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: 'Must be a valid UUIDv4.

                      '
                  type:
                    type: string
                    description: The sensor type.
                    enum:
                    - attach
                    - battery
                    - humidity
                    - pressure
                    - tamper
                    - temperature
                    - acceleration
                  range:
                    type: object
                    properties:
                      begin:
                        type: number
                        description: The lower threshold value.
                      end:
                        type: number
                        description: The upper threshold value.
                    required:
                    - begin
                    - end
                  threshold:
                    type: object
                    properties:
                      value:
   

# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/here/refs/heads/main/openapi/here-sensors-api-openapi.yml