Get Timeseries

Endpoint for Retrieving Timeseries Data from Iris360

This endpoint accepts an array of requests, allowing access to data across multiple entities. Each query is executed individually for every combination of device_id and measure_id specified, with the provided options applied directly to each pair.

Details

Specificity: Options such as limit or aggregation settings are specific to each device_id and measure_id pair, rather than being applied globally across all requests.

Defaults: Unspecified values are automatically assigned default values where applicable.

Null Values: If a null value is explicitly provided, it will be used as the value instead of any default.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

array of:

device_ids

array[string]

required

Entity identifiers (FIWARE URN)

measure_ids

array[string]

required

Attribute ids

options

object (TimeSeriesOptions)

required

Request options

start_date

string | null

optional

Date lower bound, in ISO 8601 format

end_date

string | null

optional

Date upper bound, in ISO 8601 format

order

optional

Request time ordering

limit

number | null

optional

Data point limit per device_id and measure_id.

>= 0

Default:

100

aggregation

optional

Time series aggregation options

period

optional

Advanced period filtering

query_id

string | null

optional

Client request identifier, propagated to the response so the client can identify the request.

tenant

string

required

Query tenant restriction

scope

string

required

Query scope restriction

Example

[
    {
        "device_ids": [
            "urn:ngsi-ld:Device:Device001"
        ],
        "measure_ids": [
            "Measure_A", "Measure_B"
        ],
        "options": {
            "query_id": "QueryId",
            "order": "desc",
            "end_date": "2025-01-01T10:00:30.063Z",
            "start_date": "2025-01-02T10:40:30.000Z",
            "limit": 200,
            "tenant": "libelium",
            "scope": "/"
        }
    }
]

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Successful Response Structure

The response includes a TimeSeriesResponse for each request. Each response is linked to the original request using the query_id field in the options response. The Options field represents the final parameters applied to the request, including any default values and originally unspecified null values.

The response attempts to retrieve all specified measures. If a measure is not found, no TimeSeriesStructure is returned for that measure, and no error message is generated. This also applies to cases where the entity does not exist, or an existing entity does not have a specified measure. Therefore, responses only include entries for measures that were successfully found. If no measures are found, the time_series array will be empty, but the options field will still be provided to detail the query context.

Body

array of:

time_series

array[object (TimeSeries) {3}]

required

Data points matching the query

device_id

string

required

Entity id (FIWARE URN)

measure_id

string

required

Measure id

values

array[object (TimeSeriesValue) {2}]

required

List of data points

options

object (TimeSeriesOptions)

required

The options used in the corresponding timeseries request for this response.

start_date

string | null

optional

Date lower bound, in ISO 8601 format

end_date

string | null

optional

Date upper bound, in ISO 8601 format

order

optional

Request time ordering

limit

number | null

optional

Data point limit per device_id and measure_id.

>= 0

Default:

100

aggregation

optional

Time series aggregation options

period

optional

Advanced period filtering

query_id

string | null

optional

Client request identifier, propagated to the response so the client can identify the request.

tenant

string

required

Query tenant restriction

scope

string

required

Query scope restriction

Example

[
    {
        "time_series": [
            {
                "device_id": "urn:ngsi-ld:Device:Device001",
                "measure_id": "measure_A",
                "values": [
                    {
                        "timestamp": "2025-01-01T18:10:02.904Z",
                        "value": 1
                    },
                    {
                        "timestamp": "2025-01-01T19:29:26.026Z",
                        "value": 2
                    },
                    {
                        "timestamp": "2025-01-02T20:47:32.062Z",
                        "value": 3
                    }
                ]
            },
            {
                "device_id": "urn:ngsi-ld:Device:Device001",
                "measure_id": "measure_B",
                "values": [
                    {
                        "timestamp": "2025-01-01T12:41:49.096Z",
                        "value": true
                    }
                ]
            }
        ],
        "options": {
            "query_id": "QueryId",
            "order": "desc",
            "end_date": "2025-01-01T10:00:30.063Z",
            "start_date": "2025-01-02T10:40:30.000Z",
            "limit": 200,
            "tenant": "OrganizationA",
            "scope": "/"
        }
    }
]

🟠404Not Found

🟠403Forbidden

Endpoint for Retrieving Timeseries Data from Iris360#

Details#

Request

Request samples

Responses

Endpoint for Retrieving Timeseries Data from Iris360

Details