Read measurements

GET /networks/{network_identifier}/sensors/{sensor_identifier}/measurements

By default, returns a sensor's most recent 64 measurements sorted ascendingly by creation_timestamp. You can use the creation_timestamp and direction parameters to page through the collection.

If aggregate is set to true, other query parameters are ignored and the request returns an aggregation of the sensor's measurements over the last 4 weeks.

Path parameters

  • network_identifier string Required

    Format should match the following pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$.

  • sensor_identifier string Required

    Format should match the following pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$.

Query parameters

  • direction string

    The direction of the page based on the cursor. If no cursor is provided, next returns the first page and previous returns the last page.

    Values are next or previous. Default value is next.

  • creation_timestamp number

    The cursor of the query. Depending on the direction, the request returns the next or previous elements. The element the cursor references is not included in the response.

  • aggregate boolean

    Whether to aggregate the measurements. If true, ignores other query parameters and returns the 1-hour averages over the last 4 weeks for each available attribute.

    Default value is false.

Responses

  • 200

    OK

    One of:
    Hide attributes Show attributes
    • creation_timestamp number
    • value object
      Hide value attribute Show value attribute object
      • Additional properties: number
    • revision integer

      Configurations are assigned monotonically increasing revision numbers. The revision is used as an identifier in the communication with the sensors and can clearly match configurations to measurements and logs.

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Not Found

GET /networks/{network_identifier}/sensors/{sensor_identifier}/measurements
curl \
 -X GET https://example.com/networks/575a7328-4e2e-4b88-afcc-e0b5ed3920cc/sensors/575a7328-4e2e-4b88-afcc-e0b5ed3920cc/measurements \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
[
  {
    "creation_timestamp": 1683644400.0,
    "value": {
      "temperature": 23.1,
      "humidity": 0.62
    },
    "revision": 42
  }
]
{
  "temperature": [
    {
      "bucket_timestamp": 1683644400.0,
      "average": 23.1
    }
  ]
}
Response examples (200)
[
  {
    "creation_timestamp": 1683644400.0,
    "value": {
      "humidity": 0.62,
      "temperature": 23.1
    },
    "revision": 42
  }
]
{
  "temperature": [
    {
      "average": 23.1,
      "bucket_timestamp": 1683644400.0
    }
  ]
}