AirQuality Connector - Ismena website

info@ismena.com

AirQuality Connector

Connector Details

Type

Virtual machines, Single VM , BYOL

Runs on

Google Compute Engine

Last Update

24 October, 2024

Category

Overview

The AirQuality Connector facilitates seamless integration with the OpenAQ API, providing access to real-time and historical air quality data from sensors worldwide. This connector acts as a proxy to streamline data retrieval, supporting actions for retrieving instruments, locations, manufacturers, licenses, parameters, countries, sensors, measurements, owners, providers, and flags.

Integration Overview

This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the AirQuality Connector.

Supported Integration Action Points

getInstrumentById: Retrieves details of a specific instrument by its ID.
getInstruments: Retrieves a list of instruments with optional sorting and pagination.
getInstrumentsByManufacturerId: Retrieves instruments associated with a specific manufacturer.
getLocationById: Retrieves details of a specific location by its ID.
getLocations: Retrieves a list of locations with filtering options like coordinates, radius, and country.
getLicenseById: Retrieves details of a specific license by its ID.
getLicenses: Retrieves a list of licenses with sorting and pagination options.
getParameterById: Retrieves details of a specific parameter by its ID.
getParameters: Retrieves a list of parameters with filtering by type or location.
getCountryById: Retrieves details of a specific country by its ID.
getCountries: Retrieves a list of countries with filtering options.
getManufacturerById: Retrieves details of a specific manufacturer by its ID.
getManufacturers: Retrieves a list of manufacturers with sorting and pagination.
getMeasurementsBySensorId: Retrieves measurements for a specific sensor with optional time range.
getHourlyMeasurementsBySensorId: Retrieves hourly aggregated measurements for a sensor.
getDailyMeasurementsBySensorId: Retrieves daily aggregated measurements for a sensor.
getHourlyDataBySensorId: Retrieves hourly data for a sensor with optional time range.
getDailySummariesFromHourlyBySensorId: Retrieves daily summaries of hourly data for a sensor.
getMonthlySummariesFromHourlyBySensorId: Retrieves monthly summaries of hourly data for a sensor.
getYearlySummariesFromHourlyBySensorId: Retrieves yearly summaries of hourly data for a sensor.
getHourOfDaySummariesBySensorId: Retrieves measurements aggregated by hour of day for a sensor.
getDayOfWeekSummariesBySensorId: Retrieves measurements aggregated by day of week for a sensor.
getMonthOfYearSummariesBySensorId: Retrieves measurements aggregated by month of year for a sensor.
getDayOfWeekSummariesFromDailyBySensorId: Retrieves day-of-week summaries from daily data for a sensor.
getMonthOfYearSummariesFromDailyBySensorId: Retrieves month-of-year summaries from daily data for a sensor.
getDailyDataBySensorId: Retrieves daily data for a sensor with optional time range.
getMonthlySummariesFromDailyBySensorId: Retrieves monthly summaries of daily data for a sensor.
getYearlySummariesFromDailyBySensorId: Retrieves yearly summaries of daily data for a sensor.
getYearlyDataBySensorId: Retrieves yearly data for a sensor with optional time range.
getOwnerById: Retrieves details of a specific owner by its ID.
getOwners: Retrieves a list of owners with sorting and pagination.
getProviderById: Retrieves details of a specific provider by its ID.
getProviders: Retrieves a list of providers with filtering options.
getSensorsByLocationId: Retrieves sensors associated with a specific location.
getSensorById: Retrieves details of a specific sensor by its ID.
getLatestMeasurementsByParameterId: Retrieves the latest measurements for a specific parameter.
getLatestMeasurementsByLocationId: Retrieves the latest measurements for a specific location.
getFlagsByLocationId: Retrieves flags associated with a specific location.
getFlagsBySensorId: Retrieves flags associated with a specific sensor.

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 (string, e.g., YOUR-API-KEY). Register at https://api.openaq.org to obtain. instruments_id: The ID of the instrument (integer, e.g., 123) Optional: None
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_OPENAQ_BASE_URL environment variable (e.g., https://api.openaq.org).
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, and limit. results: Array containing the instrument details (e.g., id, name, isMonitor, manufacturer). Failure: Returns error details (e.g., error-type: invalid-instrument-id, HTTP 422).
Workflow Example	Configure the connector with the appropriate base URL. Execute the getInstrumentById action with apiKey and instruments_id=123. Process the response to retrieve instrument details for display or analysis.

Instruments Retrieval

Action	getInstruments
Purpose	Retrieves a list of instruments with optional sorting and pagination.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) Optional: order_by: Field to order results (string, default: id, e.g., id) sort_order: Sort direction (string, default: asc, options: asc, desc) limit: Number of results to return (integer, default: 100) page: Page number for pagination (integer, default: 1)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, limit, and found count. results: Array of instrument objects (e.g., id, name, isMonitor, manufacturer). Failure: Returns error details (e.g., error-type: invalid-request, HTTP 422).
Workflow Example	Execute the getInstruments action with apiKey, limit=50, and sort_order=desc. Process the response to display a list of instruments. Use pagination to fetch additional results if needed.

Instruments by Manufacturer ID

Action	getInstrumentsByManufacturerId
Purpose	Retrieves a list of instruments for a specific manufacturer.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) manufacturers_id: The ID of the manufacturer (integer, e.g., 456) Optional: None
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, and limit. results: Array of instrument objects for the specified manufacturer. Failure: Returns error details (e.g., error-type: invalid-manufacturer-id, HTTP 422).
Workflow Example	Execute the getInstrumentsByManufacturerId action with apiKey and manufacturers_id=456. Review the response to obtain the list of instruments. Use the data for manufacturer-specific analysis.

Location Retrieval by ID

Action	getLocationById
Purpose	Retrieves detailed information about a specific location by its ID.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) locations_id: The ID of the location (integer, e.g., 789) Optional: None
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, and limit. results: Array containing the location details (e.g., id, name, country, coordinates). Failure: Returns error details (e.g., error-type: invalid-location-id, HTTP 422).
Workflow Example	Execute the getLocationById action with apiKey and locations_id=789. Process the response to display location details. Use the coordinates for mapping or analysis.

Locations Retrieval

Action	getLocations
Purpose	Retrieves a list of locations with filtering options such as coordinates, radius, and country.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) Optional: coordinates: Latitude, longitude pair (string, e.g., 38.9074,-77.0373) radius: Search radius in meters (integer, default: 1000, max: 25000) providers_id: Provider ID(s) (string or array, e.g., 1,2) parameters_id: Parameter ID(s) (string or array, e.g., 3,4) limit: Number of results to return (integer, default: 100) page: Page number for pagination (integer, default: 1) owner_contacts_id: Owner ID(s) (string or array, e.g., 5,6) manufacturers_id: Manufacturer ID(s) (string or array, e.g., 7,8) licenses_id: License ID(s) (string or array, e.g., 9,10) monitor: Filter by reference monitor status (boolean or string, e.g., true) mobile: Filter by mobile location status (boolean or string, e.g., false) instruments_id: Instrument ID(s) (string or array, e.g., 11,12) iso: Country code (ISO 3166-1 alpha-2, string, e.g., US) countries_id: Country ID(s) (string or array, e.g., 13,14) bbox: Bounding box coordinates (string, e.g., -77.037,38.907,-77.0,39.910)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, limit, and found count. results: Array of location objects (e.g., id, name, coordinates, country). Failure: Returns error details (e.g., error-type: invalid-coordinates, HTTP 422).
Workflow Example	Execute the getLocations action with apiKey, coordinates=38.9074,-77.0373, and radius=5000. Process the response to display locations within the specified radius. Use the data for geospatial analysis or mapping.

License Retrieval by ID

Action	getLicenseById
Purpose	Retrieves details of a specific license by its ID.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) licenses_id: The ID of the license (integer, e.g., 101) Optional: None
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, and limit. results: Array containing the license details (e.g., id, name, commercialUseAllowed, attributionRequired). Failure: Returns error details (e.g., error-type: invalid-license-id, HTTP 422).
Workflow Example	Execute the getLicenseById action with apiKey and licenses_id=101. Review the response to understand license terms. Use the data for compliance checks.

Licenses Retrieval

Action	getLicenses
Purpose	Retrieves a list of licenses with optional sorting and pagination.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) Optional: order_by: Field to order results (string, default: id, e.g., id) sort_order: Sort direction (string, default: asc, options: asc, desc) limit: Number of results to return (integer, default: 100) page: Page number for pagination (integer, default: 1)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, limit, and found count. results: Array of license objects (e.g., id, name, commercialUseAllowed). Failure: Returns error details (e.g., error-type: invalid-request, HTTP 422).
Workflow Example	Execute the getLicenses action with apiKey and limit=50. Process the response to display a list of licenses. Use the data for licensing compliance.

Parameter Retrieval by ID

Action	getParameterById
Purpose	Retrieves details of a specific parameter by its ID.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) parameters_id: The ID of the parameter (integer, e.g., 202) Optional: None
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, and limit. results: Array containing the parameter details (e.g., id, name, units, displayName). Failure: Returns error details (e.g., error-type: invalid-parameter-id, HTTP 422).
Workflow Example	Execute the getParameterById action with apiKey and parameters_id=202. Review the response to obtain parameter details. Use the data for measurement analysis.

Parameters Retrieval

Action	getParameters
Purpose	Retrieves a list of parameters with filtering options like parameter type or location.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) Optional: order_by: Field to order results (string, default: id, e.g., id) sort_order: Sort direction (string, default: asc, options: asc, desc) parameter_type: Filter by parameter type (string, e.g., pollutant, meteorological) coordinates: Latitude, longitude pair (string, e.g., 38.9074,-77.0373) radius: Search radius in meters (integer, default: 1000, max: 25000) bbox: Bounding box coordinates (string, e.g., -77.037,38.907,-77.0,39.910) iso: Country code (ISO 3166-1 alpha-2, string, e.g., US) countries_id: Country ID(s) (string or array, e.g., 13,14) limit: Number of results to return (integer, default: 100) page: Page number for pagination (integer, default: 1)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, limit, and found count. results: Array of parameter objects (e.g., id, name, units, displayName). Failure: Returns error details (e.g., error-type: invalid-request, HTTP 422).
Workflow Example	Execute the getParameters action with apiKey and parameter_type=pollutant. Process the response to display available parameters. Use the data for air quality analysis.

Country Retrieval by ID

Action	getCountryById
Purpose	Retrieves details of a specific country by its ID.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) countries_id: The ID of the country (integer, e.g., 303) Optional: None
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, and limit. results: Array containing the country details (e.g., id, code, name, parameters). Failure: Returns error details (e.g., error-type: invalid-country-id, HTTP 422).
Workflow Example	Execute the getCountryById action with apiKey and countries_id=303. Review the response to obtain country details. Use the data for regional analysis.

Countries Retrieval

Action	getCountries
Purpose	Retrieves a list of countries with filtering options.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) Optional: order_by: Field to order results (string, default: id, e.g., id) sort_order: Sort direction (string, default: asc, options: asc, desc) providers_id: Provider ID(s) (string or array, e.g., 1,2) parameters_id: Parameter ID(s) (string or array, e.g., 3,4) limit: Number of results to return (integer, default: 100) page: Page number for pagination (integer, default: 1)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, limit, and found count. results: Array of country objects (e.g., id, code, name, parameters). Failure: Returns error details (e.g., error-type: invalid-request, HTTP 422).
Workflow Example	Execute the getCountries action with apiKey and parameters_id=3. Process the response to display countries with specific parameters. Use the data for global air quality analysis.

Manufacturer Retrieval by ID

Action	getManufacturerById
Purpose	Retrieves details of a specific manufacturer by its ID.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) manufacturers_id: The ID of the manufacturer (integer, e.g., 456) Optional: None
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, and limit. results: Array containing the manufacturer details (e.g., id, name, instruments). Failure: Returns error details (e.g., error-type: invalid-manufacturer-id, HTTP 422).
Workflow Example	Execute the getManufacturerById action with apiKey and manufacturers_id=456. Review the response to obtain manufacturer details. Use the data for equipment analysis.

Manufacturers Retrieval

Action	getManufacturers
Purpose	Retrieves a list of manufacturers with sorting and pagination.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) Optional: order_by: Field to order results (string, default: id, e.g., id) sort_order: Sort direction (string, default: asc, options: asc, desc) limit: Number of results to return (integer, default: 100) page: Page number for pagination (integer, default: 1)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, limit, and found count. results: Array of manufacturer objects (e.g., id, name, instruments). Failure: Returns error details (e.g., error-type: invalid-request, HTTP 422).
Workflow Example	Execute the getManufacturers action with apiKey and limit=50. Process the response to display a list of manufacturers. Use the data for equipment cataloging.

Measurements by Sensor ID

Action	getMeasurementsBySensorId
Purpose	Retrieves measurements for a specific sensor with an optional time range.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) sensors_id: The ID of the sensor (integer, e.g., 567) Optional: datetime_from: Start date/time (string, e.g., 2023-01-01) datetime_to: End date/time (string, e.g., 2023-12-31) limit: Number of results to return (integer, default: 100) page: Page number for pagination (integer, default: 1)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, limit, and found count. results: Array of measurement objects (e.g., value, parameter, flagInfo). Failure: Returns error details (e.g., error-type: invalid-sensor-id, HTTP 422).
Workflow Example	Execute the getMeasurementsBySensorId action with apiKey, sensors_id=567, and datetime_from=2023-01-01. Process the response to analyze sensor measurements. Use the data for air quality monitoring.

Hourly Measurements by Sensor ID

Action	getHourlyMeasurementsBySensorId
Purpose	Retrieves hourly aggregated measurements for a specific sensor.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) sensors_id: The ID of the sensor (integer, e.g., 567) Optional: datetime_from: Start date/time (string, e.g., 2023-01-01) datetime_to: End date/time (string, e.g., 2023-12-31) limit: Number of results to return (integer, default: 100) page: Page number for pagination (integer, default: 1)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, limit, and found count. results: Array of hourly measurement objects (e.g., value, parameter, period). Failure: Returns error details (e.g., error-type: invalid-sensor-id, HTTP 422).
Workflow Example	Execute the getHourlyMeasurementsBySensorId action with apiKey and sensors_id=567. Process the response to analyze hourly trends. Use the data for short-term air quality analysis.

Daily Measurements by Sensor ID

Action	getDailyMeasurementsBySensorId
Purpose	Retrieves daily aggregated measurements for a specific sensor.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) sensors_id: The ID of the sensor (integer, e.g., 567) Optional: datetime_from: Start date/time (string, e.g., 2023-01-01) datetime_to: End date/time (string, e.g., 2023-12-31) limit: Number of results to return (integer, default: 100) page: Page number for pagination (integer, default: 1)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, limit, and found count. results: Array of daily measurement objects (e.g., value, parameter, period). Failure: Returns error details (e.g., error-type: invalid-sensor-id, HTTP 422).
Workflow Example	Execute the getDailyMeasurementsBySensorId action with apiKey and sensors_id=567. Process the response to analyze daily trends. Use the data for medium-term 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: Your API key (string, e.g., YOUR-API-KEY) sensors_id: The ID of the sensor (integer, e.g., 567) Optional: datetime_from: Start date/time (string, e.g., 2023-01-01) datetime_to: End date/time (string, e.g., 2023-12-31) limit: Number of results to return (integer, default: 100) page: Page number for pagination (integer, default: 1)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, limit, and found count. results: Array of hourly data objects (e.g., value, parameter, coverage). Failure: Returns error details (e.g., error-type: invalid-sensor-id, HTTP 422).
Workflow Example	Execute the getHourlyDataBySensorId action with apiKey and sensors_id=567. Process the response to analyze hourly data. Use the data for detailed air quality monitoring.

Daily Summaries from Hourly Data by Sensor ID

Action	getDailySummariesFromHourlyBySensorId
Purpose	Retrieves daily summaries of hourly data for a specific sensor.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) sensors_id: The ID of the sensor (integer, e.g., 567) Optional: datetime_from: Start date/time (string, e.g., 2023-01-01) datetime_to: End date/time (string, e.g., 2023-12-31) limit: Number of results to return (integer, default: 100) page: Page number for pagination (integer, default: 1)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, limit, and found count. results: Array of daily summary objects from hourly data (e.g., value, parameter, summary). Failure: Returns error details (e.g., error-type: invalid-sensor-id, HTTP 422).
Workflow Example	Execute the getDailySummariesFromHourlyBySensorId action with apiKey and sensors_id=567. Process the response to analyze daily summaries. Use the data for aggregated air quality reporting.

Monthly Summaries from Hourly Data by Sensor ID

Action	getMonthlySummariesFromHourlyBySensorId
Purpose	Retrieves monthly summaries of hourly data for a specific sensor.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) sensors_id: The ID of the sensor (integer, e.g., 567) Optional: datetime_from: Start date/time (string, e.g., 2023-01-01) datetime_to: End date/time (string, e.g., 2023-12-31) limit: Number of results to return (integer, default: 100) page: Page number for pagination (integer, default: 1)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, limit, and found count. results: Array of monthly summary objects from hourly data (e.g., value, parameter, summary). Failure: Returns error details (e.g., error-type: invalid-sensor-id, HTTP 422).
Workflow Example	Execute the getMonthlySummariesFromHourlyBySensorId action with apiKey and sensors_id=567. Process the response to analyze monthly trends. Use the data for long-term 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: Your API key (string, e.g., YOUR-API-KEY) sensors_id: The ID of the sensor (integer, e.g., 567) Optional: datetime_from: Start date/time (string, e.g., 2023-01-01) datetime_to: End date/time (string, e.g., 2023-12-31) limit: Number of results to return (integer, default: 100) page: Page number for pagination (integer, default: 1)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, limit, and found count. results: Array of yearly summary objects from hourly data (e.g., value, parameter, summary). Failure: Returns error details (e.g., error-type: invalid-sensor-id, HTTP 422).
Workflow Example	Execute the getYearlySummariesFromHourlyBySensorId action with apiKey and sensors_id=567. Process the response to analyze yearly trends. Use the data for annual air quality reporting.

Hour of Day Summaries by Sensor ID

Action	getHourOfDaySummariesBySensorId
Purpose	Retrieves measurements aggregated by hour of day for a specific sensor.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) sensors_id: The ID of the sensor (integer, e.g., 567) Optional: datetime_from: Start date/time (string, e.g., 2023-01-01) datetime_to: End date/time (string, e.g., 2023-12-31)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, and limit. results: Array of hour-of-day summary objects (e.g., value, parameter, period). Failure: Returns error details (e.g., error-type: invalid-sensor-id, HTTP 422).
Workflow Example	Execute the getHourOfDaySummariesBySensorId action with apiKey and sensors_id=567. Process the response to analyze diurnal patterns. Use the data for time-of-day 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: Your API key (string, e.g., YOUR-API-KEY) sensors_id: The ID of the sensor (integer, e.g., 567) Optional: datetime_from: Start date/time (string, e.g., 2023-01-01) datetime_to: End date/time (string, e.g., 2023-12-31)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, and limit. results: Array of day-of-week summary objects (e.g., value, parameter, period). Failure: Returns error details (e.g., error-type: invalid-sensor-id, HTTP 422).
Workflow Example	Execute the getDayOfWeekSummariesBySensorId action with apiKey and sensors_id=567. Process the response to analyze weekly patterns. Use the data for weekly 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: Your API key (string, e.g., YOUR-API-KEY) sensors_id: The ID of the sensor (integer, e.g., 567) Optional: datetime_from: Start date/time (string, e.g., 2023-01-01) datetime_to: End date/time (string, e.g., 2023-12-31)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, and limit. results: Array of month-of-year summary objects (e.g., value, parameter, period). Failure: Returns error details (e.g., error-type: invalid-sensor-id, HTTP 422).
Workflow Example	Execute the getMonthOfYearSummariesBySensorId action with apiKey and sensors_id=567. Process the response to analyze seasonal patterns. Use the data for seasonal 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: Your API key (string, e.g., YOUR-API-KEY) sensors_id: The ID of the sensor (integer, e.g., 567) Optional: date_from: Start date (string, e.g., 2023-01-01) date_to: End date (string, e.g., 2023-12-31)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, and limit. results: Array of day-of-week summary objects from daily data (e.g., value, parameter, period). Failure: Returns error details (e.g., error-type: invalid-sensor-id, HTTP 422).
Workflow Example	Execute the getDayOfWeekSummariesFromDailyBySensorId action with apiKey and sensors_id=567. Process the response to analyze weekly patterns from daily data. Use the data for weekly air quality reporting.

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: Your API key (string, e.g., YOUR-API-KEY) sensors_id: The ID of the sensor (integer, e.g., 567) Optional: date_from: Start date (string, e.g., 2023-01-01) date_to: End date (string, e.g., 2023-12-31)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, and limit. results: Array of month-of-year summary objects from daily data (e.g., value, parameter, period). Failure: Returns error details (e.g., error-type: invalid-sensor-id, HTTP 422).
Workflow Example	Execute the getMonthOfYearSummariesFromDailyBySensorId action with apiKey and sensors_id=567. Process the response to analyze seasonal patterns from daily data. Use the data for seasonal air quality reporting.

Daily Data by Sensor ID

Action	getDailyDataBySensorId
Purpose	Retrieves daily data for a specific sensor with an optional time range.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) sensors_id: The ID of the sensor (integer, e.g., 567) Optional: date_from: Start date (string, e.g., 2023-01-01) date_to: End date (string, e.g., 2023-12-31) limit: Number of results to return (integer, default: 100) page: Page number for pagination (integer, default: 1)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, limit, and found count. results: Array of daily data objects (e.g., value, parameter, coverage). Failure: Returns error details (e.g., error-type: invalid-sensor-id, HTTP 422).
Workflow Example	Execute the getDailyDataBySensorId action with apiKey and sensors_id=567. Process the response to analyze daily data. Use the data for daily air quality monitoring.

Monthly Summaries from Daily Data by Sensor ID

Action	getMonthlySummariesFromDailyBySensorId
Purpose	Retrieves monthly summaries of daily data for a specific sensor.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) sensors_id: The ID of the sensor (integer, e.g., 567) Optional: date_from: Start date (string, e.g., 2023-01-01) date_to: End date (string, e.g., 2023-12-31) limit: Number of results to return (integer, default: 100) page: Page number for pagination (integer, default: 1)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, limit, and found count. results: Array of monthly summary objects from daily data (e.g., value, parameter, summary). Failure: Returns error details (e.g., error-type: invalid-sensor-id, HTTP 422).
Workflow Example	Execute the getMonthlySummariesFromDailyBySensorId action with apiKey and sensors_id=567. Process the response to analyze monthly trends from daily data. Use the data for monthly air quality reporting.

Yearly Summaries from Daily Data by Sensor ID

Action	getYearlySummariesFromDailyBySensorId
Purpose	Retrieves yearly summaries of daily data for a specific sensor.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) sensors_id: The ID of the sensor (integer, e.g., 567) Optional: date_from: Start date (string, e.g., 2023-01-01) date_to: End date (string, e.g., 2023-12-31) limit: Number of results to return (integer, default: 100) page: Page number for pagination (integer, default: 1)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, limit, and found count. results: Array of yearly summary objects from daily data (e.g., value, parameter, summary). Failure: Returns error details (e.g., error-type: invalid-sensor-id, HTTP 422).
Workflow Example	Execute the getYearlySummariesFromDailyBySensorId action with apiKey and sensors_id=567. Process the response to analyze yearly trends from daily data. Use the data for annual air quality reporting.

Yearly Data by Sensor ID

Action	getYearlyDataBySensorId
Purpose	Retrieves yearly data for a specific sensor with an optional time range.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) sensors_id: The ID of the sensor (integer, e.g., 567) Optional: date_from: Start date (string, e.g., 2023-01-01) date_to: End date (string, e.g., 2023-12-31) limit: Number of results to return (integer, default: 100) page: Page number for pagination (integer, default: 1)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, limit, and found count. results: Array of yearly data objects (e.g., value, parameter, coverage). Failure: Returns error details (e.g., error-type: invalid-sensor-id, HTTP 422).
Workflow Example	Execute the getYearlyDataBySensorId action with apiKey and sensors_id=567. Process the response to analyze yearly data. Use the data for long-term air quality monitoring.

Owner Retrieval by ID

Action	getOwnerById
Purpose	Retrieves details of a specific owner by its ID.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) owners_id: The ID of the owner (integer, e.g., 808) Optional: None.
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, and limit. results: Array containing the owner details (e.g., id, name). Failure: Returns error details (e.g., error-type: invalid-owner-id, HTTP 422).
Workflow Example	Execute the getOwnerById action with apiKey and owners_id=808. Review the response to obtain owner details. Use the data for ownership analysis.

Owners Retrieval

Action	getOwners
Purpose	Retrieves a list of owners with sorting and pagination.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) Optional: order_by: Field to order results (string, default: id, e.g., id) sort_order: Sort direction (string, default: asc, options: asc, desc) limit: Number of results to return (integer, default: 100) page: Page number for pagination (integer, default: 1)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, limit, and found count. results: Array of owner objects (e.g., id, name). Failure: Returns error details (e.g., error-type: invalid-request, HTTP 422).
Workflow Example	Execute the getOwners action with apiKey and limit=50. Process the response to display a list of owners. Use the data for ownership cataloging.

Provider Retrieval by ID

Action	getProviderById
Purpose	Retrieves details of a specific provider by its ID.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) providers_id: The ID of the provider (integer, e.g., 909) Optional: None.
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, and limit. results: Array containing the provider details (e.g., id, name, sourceName, parameters). Failure: Returns error details (e.g., error-type: invalid-provider-id, HTTP 422).
Workflow Example	Execute the getProviderById action with apiKey and providers_id=909. Review the response to obtain provider details. Use the data for provider analysis.

Providers Retrieval

Action	getProviders
Purpose	Retrieves a list of providers with filtering options.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) Optional: order_by: Field to order results (string, default: id, e.g., id) sort_order: Sort direction (string, default: asc, options: asc, desc) parameters_id: Parameter ID(s) (string or array, e.g., 3,4) monitor: Filter by reference monitor status (boolean or string, e.g., true) iso: Country code (ISO 3166-1 alpha-2, string, e.g., US) countries_id: Country ID(s) (string or array, e.g., 13,14) bbox: Bounding box coordinates (string, e.g., -77.037,38.907,-77.0,39.910) coordinates: Latitude, longitude pair (string, e.g., 38.9074,-77.0373) radius: Search radius in meters (integer, default: 1000, max: 25000) limit: Number of results to return (integer, default: 100) page: Page number for pagination (integer, default: 1)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, limit, and found count. results: Array of provider objects (e.g., id, name, sourceName, parameters). Failure: Returns error details (e.g., error-type: invalid-request, HTTP 422).
Workflow Example	Execute the getProviders action with apiKey and iso=US. Process the response to display providers in a specific country. Use the data for provider cataloging.

Sensors by Location ID

Action	getSensorsByLocationId
Purpose	Retrieves sensors associated with a specific location.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) locations_id: The ID of the location (integer, e.g., 789) Optional: None.
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, and limit. results: Array of sensor objects (e.g., id, name, parameter). Failure: Returns error details (e.g., error-type: invalid-location-id, HTTP 422).
Workflow Example	Execute the getSensorsByLocationId action with apiKey and locations_id=789. Process the response to display sensors at a specific location. Use the data for location-specific sensor analysis.

Sensor Retrieval by ID

Action	getSensorById
Purpose	Retrieves details of a specific sensor by its ID.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) sensors_id: The ID of the sensor (integer, e.g., 567) Optional: None.
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, and limit. results: Array containing the sensor details (e.g., id, name, parameter, latest). Failure: Returns error details (e.g., error-type: invalid-sensor-id, HTTP 422).
Workflow Example	Execute the getSensorById action with apiKey and sensors_id=567. Review the response to obtain sensor details. Use the data for sensor-specific analysis.

Latest Measurements by Parameter ID

Action	getLatestMeasurementsByParameterId
Purpose	Retrieves the latest measurements for a specific parameter.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) parameters_id: The ID of the parameter (integer, e.g., 202) Optional: limit: Number of results to return (integer, default: 100) page: Page number for pagination (integer, default: 1) datetime_min: Minimum datetime (string, e.g., 2023-01-01)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, limit, and found count. results: Array of latest measurement objects (e.g., datetime, value, coordinates). Failure: Returns error details (e.g., error-type: invalid-parameter-id, HTTP 422).
Workflow Example	Execute the getLatestMeasurementsByParameterId action with apiKey and parameters_id=202. Process the response to display the latest measurements for a parameter. Use the data for real-time air quality monitoring.

Latest Measurements by Location ID

Action	getLatestMeasurementsByLocationId
Purpose	Retrieves the latest measurements for a specific location.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) locations_id: The ID of the location (integer, e.g., 789) Optional: limit: Number of results to return (integer, default: 100) page: Page number for pagination (integer, default: 1) datetime_min: Minimum datetime (string, e.g., 2023-01-01)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, limit, and found count. results: Array of latest measurement objects (e.g., datetime, value, coordinates). Failure: Returns error details (e.g., error-type: invalid-location-id, HTTP 422).
Workflow Example	Execute the getLatestMeasurementsByLocationId action with apiKey and locations_id=789. Process the response to display the latest measurements for a location. Use the data for location-specific real-time monitoring.

Flags by Location ID

Action	getFlagsByLocationId
Purpose	Retrieves flags associated with a specific location.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) locations_id: The ID of the location (integer, e.g., 789) Optional: limit: Number of results to return (integer, default: 100) page: Page number for pagination (integer, default: 1) datetime_from: Start date/time (string, e.g., 2023-01-01) datetime_to: End date/time (string, e.g., 2023-12-31)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, limit, and found count. results: Array of flag objects (e.g., locationId, flagType, datetimeFrom). Failure: Returns error details (e.g., error-type: invalid-location-id, HTTP 422).
Workflow Example	Execute the getFlagsByLocationId action with apiKey and locations_id=789. Process the response to review flags for a location. Use the data for data quality assurance.

Flags by Sensor ID

Action	getFlagsBySensorId
Purpose	Retrieves flags associated with a specific sensor.
Parameters	Required: apiKey: Your API key (string, e.g., YOUR-API-KEY) sensor_id: The ID of the sensor (integer, e.g., 567) Optional: limit: Number of results to return (integer, default: 100) page: Page number for pagination (integer, default: 1) datetime_from: Start date/time (string, e.g., 2023-01-01) datetime_to: End date/time (string, e.g., 2023-12-31)
Configuration	Ensure the connector is configured with the correct base URL.
Output	Successful: Returns a JSON object with: meta: Metadata including name, website, page, limit, and found count. results: Array of flag objects (e.g., locationId, flagType, datetimeFrom). Failure: Returns error details (e.g., error-type: invalid-sensor-id, HTTP 422).
Workflow Example	Execute the getFlagsBySensorId action with apiKey and sensor_id=567. Process the response to review flags for a sensor. Use the data for sensor data quality assurance.

Workflow Creation with the Connector

Example Workflow: Air Quality Monitoring and Analysis

Retrieve Parameters	Use the getParameters action with apiKey and parameter_type=pollutant to fetch available pollutant parameters. Identify target parameters (e.g., PM2.5, NO2).
Query Locations	Execute the getLocations action with apiKey, coordinates=38.9074,-77.0373, and radius=5000 to fetch locations within a specific area. Process the response to display locations on a map.
Retrieve Sensors by Location	Use the getSensorsByLocationId action with apiKey and locations_id=789 to fetch sensors at a specific location. Identify sensors measuring target parameters.
Fetch Latest Measurements	Execute the getLatestMeasurementsByLocationId action with apiKey and locations_id=789 to retrieve the latest measurements. Display real-time air quality data in a dashboard.
Analyze Historical Data	Execute the getDailyMeasurementsBySensorId action with apiKey, sensors_id=567, date_from=2023-01-01, and date_to=2023-12-31 to fetch daily measurements. Use the getMonthlySummariesFromDailyBySensorId action to analyze monthly trends. Process the data for trend analysis or reporting.
Check Data Quality	Execute the getFlagsBySensorId action with apiKey and sensor_id=567 to review flags for data quality issues. Use the flag information to ensure data reliability.

Pricing

bill-and-calculator-2023-11-27-05-25-06-utc 1

Request a Quote

Support

For Technical support please contact us on

custom-connectors-support@isolutions.sa

A tech solution company dedicated to providing innovation thus empowering businesses to thrive in the digital age.

Register to IBM x iSolution Event