Skip to content
Open AIQ

Get air quality data for a custom date range

GET
/air-quality/custom
curl --request GET \
  --url 'https://localhost:8080/api/v1/air-quality/custom?start_date=example&end_date=example' \
  --header 'Authorization: <Authorization>'

Returns air quality data points between start_date and end_date

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
start_date
required
string

Start date (YYYY-MM-DD)

end_date
required
string

End date (YYYY-MM-DD)

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
data
Array<object>
object
label
string
metrics
object
aqi
integer
heat_index
number
humidity
number
pm1_0
number
pm2_5
number
pm10_0
number
temperature
number
timestamp
string
Examplegenerated
{
  "data": [
    {
      "label": "example",
      "metrics": {
        "aqi": 1,
        "heat_index": 1,
        "humidity": 1,
        "pm1_0": 1,
        "pm2_5": 1,
        "pm10_0": 1,
        "temperature": 1
      },
      "timestamp": "example"
    }
  ]
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
detail
string
errors
Array<object>
object
code
string
detail
string
in
string
Allowed values: body query path
name
string
instance
string
status
integer
title
string
type
string
Example
{
  "detail": "One or more request values are invalid.",
  "errors": [
    {
      "code": "required",
      "detail": "name is required",
      "in": "body",
      "name": "name"
    }
  ],
  "instance": "/api/v1/devices",
  "status": 422,
  "title": "Request validation failed",
  "type": "https://docs.air-iq.net/reference/errors/#validation-error"
}

422

Section titled “422”

Unprocessable Entity

Media typeapplication/json
object
detail
string
errors
Array<object>
object
code
string
detail
string
in
string
Allowed values: body query path
name
string
instance
string
status
integer
title
string
type
string
Example
{
  "detail": "One or more request values are invalid.",
  "errors": [
    {
      "code": "required",
      "detail": "name is required",
      "in": "body",
      "name": "name"
    }
  ],
  "instance": "/api/v1/devices",
  "status": 422,
  "title": "Request validation failed",
  "type": "https://docs.air-iq.net/reference/errors/#validation-error"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
detail
string
errors
Array<object>
object
code
string
detail
string
in
string
Allowed values: body query path
name
string
instance
string
status
integer
title
string
type
string
Example
{
  "detail": "One or more request values are invalid.",
  "errors": [
    {
      "code": "required",
      "detail": "name is required",
      "in": "body",
      "name": "name"
    }
  ],
  "instance": "/api/v1/devices",
  "status": 422,
  "title": "Request validation failed",
  "type": "https://docs.air-iq.net/reference/errors/#validation-error"
}