Get averaged values

GET

/v2/averages

Parameters

Query Parameters

temporal

Any of:

PeriodNames

string

Allowed values: hour day month year hod dow moy raw

null

null

Period to aggregate. month, day, hour

parameters_id

Any of:

integer

integer

null

null

What measurand would you like?

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?

locations_id

Limit the results to a specific location by id

integer

default: 70084

Limit the results to a specific location by id

spatial

Any of:

SpatialTypes

string

Allowed values: country location total

null

null

Define how you want to aggregate in space

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

license

string

""

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

id

Any of:

Array<integer>

Array<integer>

integer

integer

null

null

name

Any of:

Array<string>

Array<string>

string

string

null

null

hour

Any of:

string

string format: date-time

null

null

day

Any of:

string

string format: date

string

string format: date-time

null

null

month

Any of:

string

string format: date

string

string format: date-time

null

null

year

Any of:

string

string format: date

string

string format: date-time

null

null

hod

Any of:

integer

integer

null

null

dow

Any of:

integer

integer

null

null

average

Any of:

number

number

null

null

measurement_count

Any of:

integer

integer

null

null

parameter

Any of:

string

string

null

null

parameterId

Any of:

integer

integer

null

null

displayName

Any of:

string

string

null

null

unit

Any of:

string

string

null

null

first_datetime

Any of:

string

string format: date-time

null

null

last_datetime

Any of:

string

string format: date-time

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string