Get measurements aggregated to year by sensor ID

GET

/v3/sensors/{sensors_id}/years

Provides a list of annual data by sensor ID

Authorizations

• APIKeyHeader

Parameters

Path Parameters

sensors_id

required

Limit the results to a specific sensors id

integer

Limit the results to a specific sensors id

Query Parameters

date_to

Any of:

string

string format: date-time

string

string format: date

null

null

To when?

date_from

Any of:

string

string format: date-time

string

string format: date

null

null

From when?

limit

Change the number of results returned. e.g. limit=100 will return up to 100 results

integer

default: 100

Change the number of results returned. e.g. limit=100 will return up to 100 results

page

Paginate through results. e.g. page=1 will return first page of results

integer

default: 1

Paginate through results. e.g. page=1 will return first page of results

Responses

200

Successful Response

object

meta

object

name

string

default: openaq-api

website

string

default: /

page

integer

default: 1

limit

integer

default: 100

found

Any of:

integer

integer

string

string

null

null

results

required

Array<object>

object

value

Any of:

number

number

null

null

flagInfo

required

object

hasFlags

required

boolean

parameter

required

object

id

required

integer

name

required

string

units

required

string

displayName

Any of:

string

string

null

null

period

Any of:

Period

object

label

required

string

interval

required

string

datetimeFrom

Any of:

DatetimeObject

object

utc

required

string format: date-time

local

required

string format: date-time

null

null

datetimeTo

Any of:

DatetimeObject

object

utc

required

string format: date-time

local

required

string format: date-time

null

null

null

null

coordinates

Any of:

Coordinates

object

latitude

Any of:

number

number

null

null

longitude

Any of:

number

number

null

null

null

null

summary

Any of:

Summary

object

min

Any of:

number

number

null

null

q02

Any of:

number

number

null

null

q25

Any of:

number

number

null

null

median

Any of:

number

number

null

null

q75

Any of:

number

number

null

null

q98

Any of:

number

number

null

null

max

Any of:

number

number

null

null

avg

Any of:

number

number

null

null

sd

Any of:

number

number

null

null

null

null

coverage

Any of:

Coverage

object

expectedCount

required

integer

expectedInterval

required

string

observedCount

required

integer

observedInterval

required

string

percentComplete

required

number

percentCoverage

required

number

datetimeFrom

Any of:

DatetimeObject

object

utc

required

string format: date-time

local

required

string format: date-time

null

null

datetimeTo

Any of:

DatetimeObject

object

utc

required

string format: date-time

local

required

string format: date-time

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string