The predictions matching the requested criteria.

get https://example.com/predictions/

Get all the predictions matching the criteria set in query string parameters. If the combination of query string parameters is not supported, the request will return 501. IMPORTANT: this endpoint is authenticated via Identity token, not via Access token. See this guide (https://pub.dev/packages/amazon_cognito_identity_dart_2) to obtain Identity tokens

Query Params

start_datetime

date-time

required

ISO8061 UTC datetime that sets the beginning of the interval to which predictions must belong.

end_datetime

date-time

required

ISO8061 UTC datetime that sets the end of the interval to which predictions must belong.

aggregation

string

The period over which data should be aggregated.

timezone

string

Has effect only when "aggregation" is used, and it is ignored otherwise. When aggregation is set to "day" or "month", "timezone" defines the timezone where days and months begin or end. Can be any value from the Time Zone Database (https://www.iana.org/time-zones, visited 2022-10-25). Default "Europe/Rome"

sensor_id

string

The URL of the sensor whose measures must be fetched. It must be in the form "/sensors/XXX". In case it is in other forms, success is not guaranteed. It is possible to use the wildcard "/sensors/*" to obtain only predictions computed in locations occupied by physical sensors. Ignored if "latitude" or "longitude" are present.

latitude

number

-90 to 90

Longitude of the point whose air quality is requested. Ignored if "longitude" is absent, or if "sensor_id" is present.

longitude

number

-180 to 180

Longitude of the point whose air quality is requested. Ignored if "latitude" is absent, or if "sensor_id" is present.

Response

200List of predictions matching with the criteria in input.