API - query-indicators


Query indicators for the given criteria.

Prerequisite

  • the entity code as{entity}, for example, “joe_bloggs”
  • the valid data stream code as {ds}, for example, “jb_sen01_pir”
  • the start timestamp as {from} in ISO 8601 format, null value means not limit the start
  • the send timestamp as {to} in ISO 8601 format, null value means not limit the end

Method

POST

URI

/api/v1/indicator/query

Request Body

{
    "entity": "joe_bloggs",
    "ds": "jb_sen01_pir",
    "from": "2018-04-06T00:00:00Z",
    "to": "2018-04-08T00:00:00Z"
}

Response Sample

200 OK
[
    {
        "entity": "joe_bloggs",
        "ds": "jb_sen01_pir",
        "ts": "2018-04-06 00:00:00.000000",
        "value": 0.96
    },
    {
        "entity": "joe_bloggs",
        "ds": "jb_sen01_pir",
        "ts": "2018-04-07 00:00:00.000000",
        "value": 0.85
    },
    {
        "entity": "joe_bloggs",
        "ds": "jb_sen01_pir",
        "ts": "2018-04-08 00:00:00.000000",
        "value": 0.83
    }
]