Custom Connector
AirQuality Connector
Global
The AirQuality Connector facilitates seamless integration with the OpenAQ API, providing access to real-time and historical air quality data from sensors worldwide. It acts as a proxy supporting instruments, locations, manufacturers, licenses, parameters, countries, sensors, measurements, owners, providers, and flags.
Overview
Integration Overview
This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the AirQuality Connector.
- getInstrumentById. Retrieves a specific instrument by ID.
- getInstruments. Retrieves a list of instruments.
- getInstrumentsByManufacturerId. Retrieves instruments for a manufacturer.
- getLocationById. Retrieves a specific location by ID.
- getLocations. Retrieves locations with filtering (coordinates, radius, country).
- getLicenseById. Retrieves a specific license by ID.
- getLicenses. Retrieves a list of licenses.
- getParameterById. Retrieves a specific parameter by ID.
- getParameters. Retrieves parameters, filterable by type or location.
- getCountryById. Retrieves a specific country by ID.
- getCountries. Retrieves a list of countries.
- getManufacturerById. Retrieves a specific manufacturer by ID.
- getManufacturers. Retrieves a list of manufacturers.
- getMeasurementsBySensorId. Retrieves measurements for a sensor.
- getHourlyMeasurementsBySensorId. Retrieves hourly measurements for a sensor.
- getDailyMeasurementsBySensorId. Retrieves daily measurements for a sensor.
- getHourlyDataBySensorId. Retrieves hourly data for a sensor.
- getDailySummariesFromHourlyBySensorId. Daily summaries of hourly data.
- getMonthlySummariesFromHourlyBySensorId. Monthly summaries of hourly data.
- getYearlySummariesFromHourlyBySensorId. Yearly summaries of hourly data.
- getHourOfDaySummariesBySensorId. Measurements by hour of day.
- getDayOfWeekSummariesBySensorId. Measurements by day of week.
- getMonthOfYearSummariesBySensorId. Measurements by month of year.
- getDayOfWeekSummariesFromDailyBySensorId. Day-of-week summaries from daily data.
- getMonthOfYearSummariesFromDailyBySensorId. Month-of-year summaries from daily data.
- getDailyDataBySensorId. Retrieves daily data for a sensor.
- getMonthlySummariesFromDailyBySensorId. Monthly summaries of daily data.
- getYearlySummariesFromDailyBySensorId. Yearly summaries of daily data.
- getYearlyDataBySensorId. Retrieves yearly data for a sensor.
- getOwnerById. Retrieves a specific owner by ID.
- getOwners. Retrieves a list of owners.
- getProviderById. Retrieves a specific provider by ID.
- getProviders. Retrieves providers with filtering.
- getSensorsByLocationId. Retrieves sensors for a location.
- getSensorById. Retrieves a specific sensor by ID.
- getLatestMeasurementsByParameterId. Latest measurements for a parameter.
- getLatestMeasurementsByLocationId. Latest measurements for a location.
- getFlagsByLocationId. Flags for a location.
- getFlagsBySensorId. Flags for a sensor.
Documentation
Detailed Integration Documentation
Instrument Retrieval by ID
| Action | getInstrumentById |
|---|---|
| Purpose | Retrieves detailed information about a specific instrument by its ID. |
| Parameters | Required: apiKey – your API key (register at api.openaq.org). instruments_id – the ID (integer). Optional: None. |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array (id, name, isMonitor, manufacturer). Failure: error details (invalid-instrument-id, HTTP 422). |
| Workflow example | Execute getInstrumentById with apiKey and the ID, then process the response for display or analysis. |
Instruments Retrieval
| Action | getInstruments |
|---|---|
| Purpose | Retrieves a list of instruments with optional sorting and pagination. |
| Parameters | Required: apiKey. Optional: order_by (default id), sort_order (asc/desc), limit (default 100), page (default 1). |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta (incl. found count) and a results array (id, name, isMonitor, manufacturer). Failure: error details (invalid-request, HTTP 422). |
| Workflow example | Execute getInstruments with apiKey and pagination options, then process the list. |
Instruments by Manufacturer ID
| Action | getInstrumentsByManufacturerId |
|---|---|
| Purpose | Retrieves detailed information about a specific manufacturer’s instruments by its ID. |
| Parameters | Required: apiKey – your API key (register at api.openaq.org). manufacturers_id – the ID (integer). Optional: None. |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array (instrument objects for the manufacturer). Failure: error details (invalid-manufacturer-id, HTTP 422). |
| Workflow example | Execute getInstrumentsByManufacturerId with apiKey and the ID, then process the response for display or analysis. |
Location Retrieval by ID
| Action | getLocationById |
|---|---|
| Purpose | Retrieves detailed information about a specific location by its ID. |
| Parameters | Required: apiKey – your API key (register at api.openaq.org). locations_id – the ID (integer). Optional: None. |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array (id, name, country, coordinates). Failure: error details (invalid-location-id, HTTP 422). |
| Workflow example | Execute getLocationById with apiKey and the ID, then process the response for display or analysis. |
Locations Retrieval
| Action | getLocations |
|---|---|
| Purpose | Retrieves a list of locations with filtering options such as coordinates, radius, and country. |
| Parameters | Required: apiKey. Optional: coordinates (lat,lon), radius (m, default 1000, max 25000), providers_id, parameters_id, limit, page, owner_contacts_id, manufacturers_id, licenses_id, monitor, mobile, instruments_id, iso, countries_id, bbox. |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta (found count) and a results array of location objects (id, name, coordinates, country). Failure: error details (invalid-coordinates, HTTP 422). |
| Workflow example | Execute getLocations with apiKey, coordinates, and radius, then display locations within the radius for geospatial analysis. |
License Retrieval by ID
| Action | getLicenseById |
|---|---|
| Purpose | Retrieves detailed information about a specific license by its ID. |
| Parameters | Required: apiKey – your API key (register at api.openaq.org). licenses_id – the ID (integer). Optional: None. |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array (id, name, commercialUseAllowed, attributionRequired). Failure: error details (invalid-license-id, HTTP 422). |
| Workflow example | Execute getLicenseById with apiKey and the ID, then process the response for display or analysis. |
Licenses Retrieval
| Action | getLicenses |
|---|---|
| Purpose | Retrieves a list of licenses with optional sorting and pagination. |
| Parameters | Required: apiKey. Optional: order_by (default id), sort_order (asc/desc), limit (default 100), page (default 1). |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta (incl. found count) and a results array (id, name, commercialUseAllowed). Failure: error details (invalid-request, HTTP 422). |
| Workflow example | Execute getLicenses with apiKey and pagination options, then process the list. |
Parameter Retrieval by ID
| Action | getParameterById |
|---|---|
| Purpose | Retrieves detailed information about a specific parameter by its ID. |
| Parameters | Required: apiKey – your API key (register at api.openaq.org). parameters_id – the ID (integer). Optional: None. |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array (id, name, units, displayName). Failure: error details (invalid-parameter-id, HTTP 422). |
| Workflow example | Execute getParameterById with apiKey and the ID, then process the response for display or analysis. |
Parameters Retrieval
| Action | getParameters |
|---|---|
| Purpose | Retrieves a list of parameters with filtering by parameter type or location. |
| Parameters | Required: apiKey. Optional: order_by, sort_order, parameter_type (pollutant/meteorological), coordinates, radius, bbox, iso, countries_id, limit, page. |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array of parameter objects (id, name, units, displayName). Failure: error details (invalid-request, HTTP 422). |
| Workflow example | Execute getParameters with apiKey and parameter_type=pollutant, then display available parameters. |
Country Retrieval by ID
| Action | getCountryById |
|---|---|
| Purpose | Retrieves detailed information about a specific country by its ID. |
| Parameters | Required: apiKey – your API key (register at api.openaq.org). countries_id – the ID (integer). Optional: None. |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array (id, code, name, parameters). Failure: error details (invalid-country-id, HTTP 422). |
| Workflow example | Execute getCountryById with apiKey and the ID, then process the response for display or analysis. |
Countries Retrieval
| Action | getCountries |
|---|---|
| Purpose | Retrieves a list of countries with filtering options. |
| Parameters | Required: apiKey. Optional: order_by, sort_order, providers_id, parameters_id, limit, page. |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array of country objects (id, code, name, parameters). Failure: error details (invalid-request, HTTP 422). |
| Workflow example | Execute getCountries with apiKey and parameters_id, then display countries with specific parameters. |
Manufacturer Retrieval by ID
| Action | getManufacturerById |
|---|---|
| Purpose | Retrieves detailed information about a specific manufacturer by its ID. |
| Parameters | Required: apiKey – your API key (register at api.openaq.org). manufacturers_id – the ID (integer). Optional: None. |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array (id, name, instruments). Failure: error details (invalid-manufacturer-id, HTTP 422). |
| Workflow example | Execute getManufacturerById with apiKey and the ID, then process the response for display or analysis. |
Manufacturers Retrieval
| Action | getManufacturers |
|---|---|
| Purpose | Retrieves a list of manufacturers with sorting and pagination. |
| Parameters | Required: apiKey. Optional: order_by (default id), sort_order (asc/desc), limit (default 100), page (default 1). |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta (incl. found count) and a results array (id, name, instruments). Failure: error details (invalid-request, HTTP 422). |
| Workflow example | Execute getManufacturers with apiKey and pagination options, then process the list. |
Measurements by Sensor ID
| Action | getMeasurementsBySensorId |
|---|---|
| Purpose | Retrieves measurements for a specific sensor with an optional time range. |
| Parameters | Required: apiKey, sensors_id (integer). Optional: datetime_from / datetime_to (e.g. 2023-01-01), limit (default 100), page (default 1). |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array of summary objects (value, parameter, period). Failure: error details (invalid-sensor-id, HTTP 422). |
| Workflow example | Execute getMeasurementsBySensorId with apiKey and sensors_id, then process the response for air quality analysis. |
Hourly Measurements by Sensor ID
| Action | getHourlyMeasurementsBySensorId |
|---|---|
| Purpose | Retrieves hourly aggregated measurements for a specific sensor. |
| Parameters | Required: apiKey, sensors_id (integer). Optional: datetime_from / datetime_to (e.g. 2023-01-01), limit (default 100), page (default 1). |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array of summary objects (value, parameter, period). Failure: error details (invalid-sensor-id, HTTP 422). |
| Workflow example | Execute getHourlyMeasurementsBySensorId with apiKey and sensors_id, then process the response for air quality analysis. |
Daily Measurements by Sensor ID
| Action | getDailyMeasurementsBySensorId |
|---|---|
| Purpose | Retrieves daily aggregated measurements for a specific sensor. |
| Parameters | Required: apiKey, sensors_id (integer). Optional: datetime_from / datetime_to (e.g. 2023-01-01), limit (default 100), page (default 1). |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array of summary objects (value, parameter, period). Failure: error details (invalid-sensor-id, HTTP 422). |
| Workflow example | Execute getDailyMeasurementsBySensorId with apiKey and sensors_id, then process the response for air quality analysis. |
Hourly Data by Sensor ID
| Action | getHourlyDataBySensorId |
|---|---|
| Purpose | Retrieves hourly data for a specific sensor with an optional time range. |
| Parameters | Required: apiKey, sensors_id (integer). Optional: datetime_from / datetime_to (e.g. 2023-01-01), limit (default 100), page (default 1). |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array of summary objects (value, parameter, period). Failure: error details (invalid-sensor-id, HTTP 422). |
| Workflow example | Execute getHourlyDataBySensorId with apiKey and sensors_id, then process the response for air quality analysis. |
Daily Summaries from Hourly Data by Sensor ID
| Action | getDailySummariesFromHourlyBySensorId |
|---|---|
| Purpose | Retrieves daily summaries of hourly data for a specific sensor. |
| Parameters | Required: apiKey, sensors_id (integer). Optional: datetime_from / datetime_to (e.g. 2023-01-01), limit (default 100), page (default 1). |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array of summary objects (value, parameter, period). Failure: error details (invalid-sensor-id, HTTP 422). |
| Workflow example | Execute getDailySummariesFromHourlyBySensorId with apiKey and sensors_id, then process the response for air quality analysis. |
Monthly Summaries from Hourly Data by Sensor ID
| Action | getMonthlySummariesFromHourlyBySensorId |
|---|---|
| Purpose | Retrieves monthly summaries of hourly data for a specific sensor. |
| Parameters | Required: apiKey, sensors_id (integer). Optional: datetime_from / datetime_to (e.g. 2023-01-01), limit (default 100), page (default 1). |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array of summary objects (value, parameter, period). Failure: error details (invalid-sensor-id, HTTP 422). |
| Workflow example | Execute getMonthlySummariesFromHourlyBySensorId with apiKey and sensors_id, then process the response for air quality analysis. |
Yearly Summaries from Hourly Data by Sensor ID
| Action | getYearlySummariesFromHourlyBySensorId |
|---|---|
| Purpose | Retrieves yearly summaries of hourly data for a specific sensor. |
| Parameters | Required: apiKey, sensors_id (integer). Optional: datetime_from / datetime_to (e.g. 2023-01-01), limit (default 100), page (default 1). |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array of summary objects (value, parameter, period). Failure: error details (invalid-sensor-id, HTTP 422). |
| Workflow example | Execute getYearlySummariesFromHourlyBySensorId with apiKey and sensors_id, then process the response for air quality analysis. |
Hour of Day Summaries by Sensor ID
| Action | getHourOfDaySummariesBySensorId |
|---|---|
| Purpose | Retrieves measurements aggregated by hour of day for a specific sensor. |
| Parameters | Required: apiKey, sensors_id (integer). Optional: datetime_from / datetime_to (e.g. 2023-01-01), limit (default 100), page (default 1). |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array of summary objects (value, parameter, period). Failure: error details (invalid-sensor-id, HTTP 422). |
| Workflow example | Execute getHourOfDaySummariesBySensorId with apiKey and sensors_id, then process the response for air quality analysis. |
Day of Week Summaries by Sensor ID
| Action | getDayOfWeekSummariesBySensorId |
|---|---|
| Purpose | Retrieves measurements aggregated by day of week for a specific sensor. |
| Parameters | Required: apiKey, sensors_id (integer). Optional: datetime_from / datetime_to (e.g. 2023-01-01), limit (default 100), page (default 1). |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array of summary objects (value, parameter, period). Failure: error details (invalid-sensor-id, HTTP 422). |
| Workflow example | Execute getDayOfWeekSummariesBySensorId with apiKey and sensors_id, then process the response for air quality analysis. |
Month of Year Summaries by Sensor ID
| Action | getMonthOfYearSummariesBySensorId |
|---|---|
| Purpose | Retrieves measurements aggregated by month of year for a specific sensor. |
| Parameters | Required: apiKey, sensors_id (integer). Optional: datetime_from / datetime_to (e.g. 2023-01-01), limit (default 100), page (default 1). |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array of summary objects (value, parameter, period). Failure: error details (invalid-sensor-id, HTTP 422). |
| Workflow example | Execute getMonthOfYearSummariesBySensorId with apiKey and sensors_id, then process the response for air quality analysis. |
Day of Week Summaries from Daily Data by Sensor ID
| Action | getDayOfWeekSummariesFromDailyBySensorId |
|---|---|
| Purpose | Retrieves day-of-week summaries from daily data for a specific sensor. |
| Parameters | Required: apiKey, sensors_id (integer). Optional: date_from / date_to (e.g. 2023-01-01), limit (default 100), page (default 1). |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array of summary objects (value, parameter, period). Failure: error details (invalid-sensor-id, HTTP 422). |
| Workflow example | Execute getDayOfWeekSummariesFromDailyBySensorId with apiKey and sensors_id, then process the response for air quality analysis. |
Month of Year Summaries from Daily Data by Sensor ID
| Action | getMonthOfYearSummariesFromDailyBySensorId |
|---|---|
| Purpose | Retrieves month-of-year summaries from daily data for a specific sensor. |
| Parameters | Required: apiKey, sensors_id (integer). Optional: date_from / date_to (e.g. 2023-01-01), limit (default 100), page (default 1). |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array of summary objects (value, parameter, period). Failure: error details (invalid-sensor-id, HTTP 422). |
| Workflow example | Execute getMonthOfYearSummariesFromDailyBySensorId with apiKey and sensors_id, then process the response for air quality analysis. |
Daily Data by Sensor ID
| Action | getDailyDataBySensorId |
|---|---|
| Purpose | Retrieves daily data for a specific sensor with an optional time range. |
| Parameters | Required: apiKey, sensors_id (integer). Optional: date_from / date_to (e.g. 2023-01-01), limit (default 100), page (default 1). |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array of summary objects (value, parameter, period). Failure: error details (invalid-sensor-id, HTTP 422). |
| Workflow example | Execute getDailyDataBySensorId with apiKey and sensors_id, then process the response for air quality analysis. |
Monthly Summaries from Daily Data by Sensor ID
| Action | getMonthlySummariesFromDailyBySensorId |
|---|---|
| Purpose | Retrieves monthly summaries of daily data for a specific sensor. |
| Parameters | Required: apiKey, sensors_id (integer). Optional: date_from / date_to (e.g. 2023-01-01), limit (default 100), page (default 1). |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array of summary objects (value, parameter, period). Failure: error details (invalid-sensor-id, HTTP 422). |
| Workflow example | Execute getMonthlySummariesFromDailyBySensorId with apiKey and sensors_id, then process the response for air quality analysis. |
Yearly Summaries from Daily Data by Sensor ID
| Action | getYearlySummariesFromDailyBySensorId |
|---|---|
| Purpose | Retrieves yearly summaries of daily data for a specific sensor. |
| Parameters | Required: apiKey, sensors_id (integer). Optional: date_from / date_to (e.g. 2023-01-01), limit (default 100), page (default 1). |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array of summary objects (value, parameter, period). Failure: error details (invalid-sensor-id, HTTP 422). |
| Workflow example | Execute getYearlySummariesFromDailyBySensorId with apiKey and sensors_id, then process the response for air quality analysis. |
Yearly Data by Sensor ID
| Action | getYearlyDataBySensorId |
|---|---|
| Purpose | Retrieves yearly data for a specific sensor with an optional time range. |
| Parameters | Required: apiKey, sensors_id (integer). Optional: date_from / date_to (e.g. 2023-01-01), limit (default 100), page (default 1). |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array of summary objects (value, parameter, period). Failure: error details (invalid-sensor-id, HTTP 422). |
| Workflow example | Execute getYearlyDataBySensorId with apiKey and sensors_id, then process the response for air quality analysis. |
Owner Retrieval by ID
| Action | getOwnerById |
|---|---|
| Purpose | Retrieves detailed information about a specific owner by its ID. |
| Parameters | Required: apiKey – your API key (register at api.openaq.org). owners_id – the ID (integer). Optional: None. |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array (id, name). Failure: error details (invalid-owner-id, HTTP 422). |
| Workflow example | Execute getOwnerById with apiKey and the ID, then process the response for display or analysis. |
Owners Retrieval
| Action | getOwners |
|---|---|
| Purpose | Retrieves a list of owners with sorting and pagination. |
| Parameters | Required: apiKey. Optional: order_by (default id), sort_order (asc/desc), limit (default 100), page (default 1). |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta (incl. found count) and a results array (id, name). Failure: error details (invalid-request, HTTP 422). |
| Workflow example | Execute getOwners with apiKey and pagination options, then process the list. |
Provider Retrieval by ID
| Action | getProviderById |
|---|---|
| Purpose | Retrieves detailed information about a specific provider by its ID. |
| Parameters | Required: apiKey – your API key (register at api.openaq.org). providers_id – the ID (integer). Optional: None. |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array (id, name, sourceName, parameters). Failure: error details (invalid-provider-id, HTTP 422). |
| Workflow example | Execute getProviderById with apiKey and the ID, then process the response for display or analysis. |
Providers Retrieval
| Action | getProviders |
|---|---|
| Purpose | Retrieves a list of providers with filtering options. |
| Parameters | Required: apiKey. Optional: order_by, sort_order, parameters_id, monitor, iso, countries_id, bbox, coordinates, radius, limit, page. |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array of provider objects (id, name, sourceName, parameters). Failure: error details (invalid-request, HTTP 422). |
| Workflow example | Execute getProviders with apiKey and iso=US, then display providers in a specific country. |
Sensors by Location ID
| Action | getSensorsByLocationId |
|---|---|
| Purpose | Retrieves detailed information about a specific location’s sensors by its ID. |
| Parameters | Required: apiKey – your API key (register at api.openaq.org). locations_id – the ID (integer). Optional: None. |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array (sensor objects (id, name, parameter)). Failure: error details (invalid-location-id, HTTP 422). |
| Workflow example | Execute getSensorsByLocationId with apiKey and the ID, then process the response for display or analysis. |
Sensor Retrieval by ID
| Action | getSensorById |
|---|---|
| Purpose | Retrieves detailed information about a specific sensor by its ID. |
| Parameters | Required: apiKey – your API key (register at api.openaq.org). sensors_id – the ID (integer). Optional: None. |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array (id, name, parameter, latest). Failure: error details (invalid-sensor-id, HTTP 422). |
| Workflow example | Execute getSensorById with apiKey and the ID, then process the response for display or analysis. |
Latest Measurements by Parameter ID
| Action | getLatestMeasurementsByParameterId |
|---|---|
| Purpose | Retrieves the latest measurements for a specific parameter. |
| Parameters | Required: apiKey, parameters_id. Optional: limit, page, datetime_min. |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array of latest measurement objects (datetime, value, coordinates). Failure: error details (invalid-parameter-id, HTTP 422). |
| Workflow example | Execute getLatestMeasurementsByParameterId with apiKey and parameters_id for real-time monitoring. |
Latest Measurements by Location ID
| Action | getLatestMeasurementsByLocationId |
|---|---|
| Purpose | Retrieves the latest measurements for a specific location. |
| Parameters | Required: apiKey, locations_id. Optional: limit, page, datetime_min. |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array of latest measurement objects (datetime, value, coordinates). Failure: error details (invalid-location-id, HTTP 422). |
| Workflow example | Execute getLatestMeasurementsByLocationId with apiKey and locations_id for location-specific real-time monitoring. |
Flags by Location ID
| Action | getFlagsByLocationId |
|---|---|
| Purpose | Retrieves flags associated with a specific location. |
| Parameters | Required: apiKey, locations_id. Optional: limit, page, datetime_from, datetime_to. |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array of flag objects (locationId, flagType, datetimeFrom). Failure: error details (invalid-location-id, HTTP 422). |
| Workflow example | Execute getFlagsByLocationId with apiKey and locations_id for data quality assurance. |
Flags by Sensor ID
| Action | getFlagsBySensorId |
|---|---|
| Purpose | Retrieves flags associated with a specific sensor. |
| Parameters | Required: apiKey, sensor_id. Optional: limit, page, datetime_from, datetime_to. |
| Configuration | Configure the connector with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL (e.g. https://api.openaq.org). |
| Output | Successful: JSON with meta and a results array of flag objects (locationId, flagType, datetimeFrom). Failure: error details (invalid-sensor-id, HTTP 422). |
| Workflow example | Execute getFlagsBySensorId with apiKey and sensor_id for sensor data quality assurance. |
Example Workflow: Air Quality Monitoring and Analysis
| Retrieve parameters | Use getParameters with apiKey and parameter_type=pollutant to fetch pollutant parameters (e.g. PM2.5, NO2). |
|---|---|
| Query locations | Execute getLocations with apiKey, coordinates, and radius to fetch locations within an area. |
| Retrieve sensors by location | Use getSensorsByLocationId with apiKey and locations_id to fetch sensors at a location. |
| Fetch latest measurements | Execute getLatestMeasurementsByLocationId to display real-time air quality data in a dashboard. |
| Analyze historical data | Execute getDailyMeasurementsBySensorId and getMonthlySummariesFromDailyBySensorId for trend analysis. |
| Check data quality | Execute getFlagsBySensorId to review flags and ensure data reliability. |
Support
For technical support, contact custom-connectors-support@isolutions.sa.