GET

Timeseries Instance

Endpoint for interacting with timeseries metadata.

Query parameters:

uuid Exact filter on uuid.

uuid__in List filter on uuid. UUIDs must be comma separated.

name Filter on name. Filter methods exact and startswith are supported.

code Filter on code. Filter methods exact and startswith are supported.

start: Temporal filter on start. Supports various lookup types (exact, lt, lte, gt, gte; start__exact by default). Filter values should be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.

end: Temporal filter on end. Supports various lookup types (exact, lt, lte, gt, gte; end__exact by default). Filter values should be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.

value_type Filter on value_type. Choices are integer, float, boolean, text, image, movie, file, float array.

observation_type__id Filter on observation_type__id. Filter method exact is supported.

observation_type__code Filter on observation_type__code. Filter methods exact and startswith are supported.

datasource__id Filter on datasource__id. Filter method exact is supported.

datasource__uuid Filter on datasource__uuid field. Filter method exact is supported.

location__uuid Filter on location__uuid field. Filter method exact is supported.

location__organisation__uuid (Requires also filter on code) Filter on location__organisation__uuid. Filter method exact is supported.

monitoring_network__id Filter on monitoring_network__id. Filter method exact is supported.

access_modifier Filter on access_modifier, options are 'Public', 'Private', 'Common', or 'Hidden'.

created: Temporal filter on created. Supports various lookup types (exact, lt, lte, gt, gte; created__exact by default). Filter values should be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.

last_modified: Temporal filter on last_modified. Supports various lookup types (exact, lt, lte, gt, gte; last_modified__exact by default). Filter values should be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.

Examples

?uuid=d08a97db-80b4-4a0b-bc5b-078f97a948e5

?uuid__in=d08a97db-80b4-4a0b-bc5b-078f97a948e5,9723f42c-820a-4c5f-96ce-9febef948f53

?name=my-timeseries

?name__startswith=my-tim

?code=abc&location__uuid=b10eaf1f-2867-4ffb-8f4a-5eb9bd37dbf1

?code__startswith=a&location__uuid=b10eaf1f-2867-4ffb-8f4a-5eb9bd37dbf1

?start__gte=2017-01-01T00:00:00Z

?end__lt=2018-01-01T00:00:00Z

?value_type=float

?observation_type=1

?observation_type__id=1

?observation_type__code=my-code

?observation_type__code__startswith=my-c

?datasource=1

?datasource__id=1

?datasource__uuid=b10eaf1f-2867-4ffb-8f4a-5eb9bd37dbf1

?location__code=MOB_MP_P_5min

?location__name__startswith=Rotterdam

?location__organisation__uuid=b10eaf1f-2867-4ffb-8f4a-5eb9bd37dbf1

?location__uuid=b10eaf1f-2867-4ffb-8f4a-5eb9bd37dbf1

?access_modifier=Private

?access_modifier=100

?created__gte=2017-01-01T00:00:00Z

?last_modified__lt=2018-01-01T00:00:00Z

GET /api/v4/timeseries/db2d2baa-f15b-413a-844f-e7d4008495d0/?format=api
HTTP 200 OK
Allow: GET, PUT, PATCH, DELETE, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "url": "https://demo.lizard.net/api/v4/timeseries/db2d2baa-f15b-413a-844f-e7d4008495d0/?format=api",
    "uuid": "db2d2baa-f15b-413a-844f-e7d4008495d0",
    "code": "WNS2009.teruglevering::second::1::900",
    "name": "WNS2009.teruglevering",
    "description": "",
    "start": "2018-12-13T23:45:00Z",
    "end": "2023-07-18T03:15:00Z",
    "value_type": "float",
    "last_value": 0.0,
    "interval": null,
    "observation_type": {
        "url": "https://demo.lizard.net/api/v4/observationtypes/1060/?format=api",
        "id": 1060,
        "code": "WNS2009.teruglevering",
        "parameter": "Energie teruglevering",
        "unit": "kWh",
        "scale": "ratio",
        "description": "Hoeveelheid energie die wordt teruggeleverd op het stroomnet.",
        "domain_values": null,
        "reference_frame": null,
        "compartment": "AW",
        "created": "2019-07-17T10:23:32.107013Z",
        "last_modified": "2019-07-17T12:05:38.484797Z"
    },
    "datasource": null,
    "supplier": null,
    "supplier_code": null,
    "location": {
        "url": "https://demo.lizard.net/api/v4/locations/be6f241b-1990-4419-9645-b951fe407d5e/?format=api",
        "uuid": "be6f241b-1990-4419-9645-b951fe407d5e",
        "name": "Groeterpolder",
        "code": "KGM-Q-29175"
    },
    "extra_metadata": {},
    "created": "2019-07-17T11:35:11.167494Z",
    "last_modified": "2023-07-21T03:10:45.224733Z",
    "access_modifier": "Public"
}