### Get Place Information Source: https://api.airgradient.com/public/docs/api/v1 Retrieves information about the authenticated place. ```APIDOC ## GET /public/api/v1/place ### Description Returns information about the authenticated place. ### Method GET ### Endpoint /public/api/v1/place ``` -------------------------------- ### Get All Current Measures of the Place Source: https://api.airgradient.com/public/docs/api/v1 Retrieves all current sensor measurements for the authenticated place. ```APIDOC ## GET /public/api/v1/locations/measures/current ### Description Gets all current measures of the place. ### Method GET ### Endpoint /public/api/v1/locations/measures/current ``` -------------------------------- ### Get All Triggered Alarms Source: https://api.airgradient.com/public/docs/api/v1 Retrieves a list of all currently triggered alarms for the place. ```APIDOC ## GET /public/api/v1/alarms/triggered ### Description Gets all currently triggered alarms of the place. ### Method GET ### Endpoint /public/api/v1/alarms/triggered ``` -------------------------------- ### Get Authenticated Place Information Source: https://api.airgradient.com/public/docs/api/v1/swagger.json Retrieves information about the authenticated place, including its ID, name, and timezone. ```APIDOC ## GET /public/api/v1/place ### Description Returns information about the authenticated place. ### Method GET ### Endpoint /public/api/v1/place ### Response #### Success Response (200) - **Place** - An object containing place details. ``` -------------------------------- ### Get All Current Measures Source: https://api.airgradient.com/public/docs/api/v1/swagger.json Retrieves all current sensor measurements for the place associated with the API token. ```APIDOC ## GET /public/api/v1/locations/measures/current ### Description Gets all current measures of the place. ### Method GET ### Endpoint /public/api/v1/locations/measures/current ### Parameters None ### Request Example None ### Response #### Success Response (200) OK (schema: Measures) #### Error Response (401) Not authorized #### Error Response (404) No data available ``` -------------------------------- ### Get Triggered Alarms Source: https://api.airgradient.com/public/docs/api/v1/swagger.json Retrieves all currently triggered alarms for the place associated with the API token. ```APIDOC ## GET /public/api/v1/alarms/triggered ### Description Gets all currently triggered alarms of the place. ### Method GET ### Endpoint /public/api/v1/alarms/triggered ### Parameters None ### Request Example None ### Response #### Success Response (200) OK (schema: TriggeredAlarms) #### Error Response (401) Not authorized #### Error Response (404) No data available ``` -------------------------------- ### Get Current Measures Source: https://api.airgradient.com/public/docs/api/v1/swagger.json Retrieves the current sensor measurements for a specified location. ```APIDOC ## GET /public/api/v1/locations/{locationId}/measures/current ### Description Gets the current measures of a location. ### Method GET ### Endpoint /public/api/v1/locations/{locationId}/measures/current ### Parameters #### Path Parameters - **locationId** (number) - Required - The unique id of the location ### Request Example None ### Response #### Success Response (200) OK (schema: GoMeasure) #### Error Response (401) Not authorized #### Error Response (404) No data available ``` -------------------------------- ### Get LED Mode for a Location's Sensor Source: https://api.airgradient.com/public/docs/api/v1 Retrieves the current LED mode configuration for a sensor at a specific location. ```APIDOC ## GET /public/api/v1/locations/{locationId}/sensor/config/leds/mode ### Description Gets the led mode. ### Method GET ### Endpoint /public/api/v1/locations/{locationId}/sensor/config/leds/mode ### Parameters #### Path Parameters - **locationId** (string) - Required - The ID of the location. ``` -------------------------------- ### Get LED Mode by Serial Number Source: https://api.airgradient.com/public/docs/api/v1/swagger.json Retrieves the current LED mode configuration for a sensor using its serial number. ```APIDOC ## GET /public/api/v1/sensors/{serialno}/config/leds/mode ### Description Gets the led mode. ### Method GET ### Endpoint /public/api/v1/sensors/{serialno}/config/leds/mode #### Path Parameters - **serialno** (string) - Required - The serial number of the sensor ### Response #### Success Response (200) - **LedMode** - The current LED mode configuration. ``` -------------------------------- ### Get LED Mode by Location ID Source: https://api.airgradient.com/public/docs/api/v1/swagger.json Retrieves the current LED mode configuration for a sensor at a specific location. ```APIDOC ## GET /public/api/v1/locations/{locationId}/sensor/config/leds/mode ### Description Gets the led mode. ### Method GET ### Endpoint /public/api/v1/locations/{locationId}/sensor/config/leds/mode #### Path Parameters - **locationId** (number) - Required - The unique id of the location ### Response #### Success Response (200) - **LedMode** - The current LED mode configuration. ``` -------------------------------- ### Get Current Measures of All Public Locations Source: https://api.airgradient.com/public/docs/api/v1 Retrieves the current sensor measurements for all locations that are publicly accessible. ```APIDOC ## GET /public/api/v1/world/locations/measures/current ### Description Gets the current measures of all locations that are made public to the world. ### Method GET ### Endpoint /public/api/v1/world/locations/measures/current ``` -------------------------------- ### Get Current Measures of a Location Source: https://api.airgradient.com/public/docs/api/v1 Retrieves the current sensor measurements for a specified location. ```APIDOC ## GET /public/api/v1/locations/{locationId}/measures/current ### Description Gets the current measures of a location. ### Method GET ### Endpoint /public/api/v1/locations/{locationId}/measures/current ### Parameters #### Path Parameters - **locationId** (string) - Required - The ID of the location. ``` -------------------------------- ### Get LED Mode for a Sensor Source: https://api.airgradient.com/public/docs/api/v1 Retrieves the current LED mode configuration for a specific sensor, identified by its serial number. ```APIDOC ## GET /public/api/v1/sensors/{serialno}/config/leds/mode ### Description Gets the led mode. ### Method GET ### Endpoint /public/api/v1/sensors/{serialno}/config/leds/mode ### Parameters #### Path Parameters - **serialno** (string) - Required - The serial number of the sensor. ``` -------------------------------- ### Get Average Values Across Locations in Buckets Source: https://api.airgradient.com/public/docs/api/v1 Retrieves the average sensor values across a set of specified locations, aggregated into buckets of a given size. ```APIDOC ## GET /public/api/v1/locations/{locationIds}/measures/buckets/{bucketSize} ### Description Gets the average values across a set of locations in buckets. ### Method GET ### Endpoint /public/api/v1/locations/{locationIds}/measures/buckets/{bucketSize} ### Parameters #### Path Parameters - **locationIds** (string) - Required - A comma-separated list of location IDs. - **bucketSize** (string) - Required - The size of the buckets (e.g., '5min', '60min'). ``` -------------------------------- ### Get Current Measures of World Source: https://api.airgradient.com/public/docs/api/v1/swagger.json Retrieves the current sensor measurements for all locations that have been made public globally. ```APIDOC ## GET /public/api/v1/world/locations/measures/current ### Description Gets the current measures of all locations that are made public to the world. ### Method GET ### Endpoint /public/api/v1/world/locations/measures/current ### Parameters None ### Request Example None ### Response #### Success Response (200) OK (schema: Measures) #### Error Response (401) Not authorized #### Error Response (404) No data available ``` -------------------------------- ### Get Past Measures Source: https://api.airgradient.com/public/docs/api/v1/swagger.json Retrieves past sensor measurements for a location, aggregated into 5-minute or 60-minute buckets, within a specified date range. ```APIDOC ## GET /public/api/v1/locations/{locationId}/measures/past ### Description Gets past measures of a location in 5 minute buckets or 60 minutes buckets (depending on what is available). ### Method GET ### Endpoint /public/api/v1/locations/{locationId}/measures/past ### Parameters #### Path Parameters - **locationId** (number) - Required - The unique id of the location #### Query Parameters - **from** (string) - Required - The date from which measures are requested in ISO 8601 format with UTC offset (basic format, e.g 20220328T120500Z) - **to** (string) - Required - The date to which measures are requested in ISO 8601 format with UTC offset (basic format, e.g 20220328T230500Z). Must be after parameter from. The from .. to interval is limited to 10 days. ### Request Example None ### Response #### Success Response (200) OK (schema: Measures) #### Error Response (400) Bad request #### Error Response (401) Not authorized #### Error Response (404) No data available #### Error Response (422) from .. to interval is too large ``` -------------------------------- ### Get Past Measures of a Location Source: https://api.airgradient.com/public/docs/api/v1 Retrieves past sensor measurements for a location, aggregated into 5-minute or 60-minute buckets. ```APIDOC ## GET /public/api/v1/locations/{locationId}/measures/past ### Description Gets past measures of a location in 5 minute buckets or 60 minutes buckets (depending on what is available). ### Method GET ### Endpoint /public/api/v1/locations/{locationId}/measures/past ### Parameters #### Path Parameters - **locationId** (string) - Required - The ID of the location. ``` -------------------------------- ### Get Measures Average Source: https://api.airgradient.com/public/docs/api/v1/swagger.json Retrieves the average sensor values across a set of locations, aggregated into specified time buckets. ```APIDOC ## GET /public/api/v1/locations/{locationIds}/measures/buckets/{bucketSize} ### Description Gets the average values across a set of locations in buckets. ### Method GET ### Endpoint /public/api/v1/locations/{locationIds}/measures/buckets/{bucketSize} ### Parameters #### Path Parameters - **locationIds** (string) - Required - A comma separated list of location ids, e.g. - **bucketSize** (string) - Required - The size of the buckets for aggregation (e.g., '5min', '1h'). ### Request Example None ### Response #### Success Response (200) OK #### Error Response (400) Bad request #### Error Response (401) Not authorized #### Error Response (404) No data available ``` -------------------------------- ### Get Current Measures of a Specific Public Location Source: https://api.airgradient.com/public/docs/api/v1 Retrieves the current sensor measurements for a specific location that is publicly accessible. ```APIDOC ## GET /public/api/v1/world/locations/{locationId}/measures/current ### Description Gets the current measures of a certain location that is made public to the world. ### Method GET ### Endpoint /public/api/v1/world/locations/{locationId}/measures/current ### Parameters #### Path Parameters - **locationId** (string) - Required - The ID of the location. ``` -------------------------------- ### Get Raw Measures Source: https://api.airgradient.com/public/docs/api/v1/swagger.json Retrieves the 200 most recent raw sensor measurements for a location, optionally filtered by a date range. ```APIDOC ## GET /public/api/v1/locations/{locationId}/measures/raw ### Description Gets the 200 most recent raw measures of a location or from a certain date range. The records are ordered by date descending. ### Method GET ### Endpoint /public/api/v1/locations/{locationId}/measures/raw ### Parameters #### Path Parameters - **locationId** (number) - Required - The unique id of the location #### Query Parameters - **from** (string) - Optional - The date from which measures are requested in ISO 8601 format with UTC offset (basic format, e.g 20240328T120500Z) - **to** (string) - Optional - The date to which measures are requested in ISO 8601 format with UTC offset (basic format, e.g 20240328T230500Z). Must be after parameter from. The from .. to interval is limited to 2 days. ### Request Example None ### Response #### Success Response (200) OK (schema: GoMeasures) #### Error Response (400) Bad request #### Error Response (401) Not authorized #### Error Response (404) No data available ``` -------------------------------- ### Get Merged Measures History for a Route Source: https://api.airgradient.com/public/docs/api/v1 Retrieves the merged historical sensor measurements for a specific route, identified by its UUID. ```APIDOC ## GET /public/api/v1/routes/{uuid}/measures ### Description Gets merged measures history for a route by UUID. ### Method GET ### Endpoint /public/api/v1/routes/{uuid}/measures ### Parameters #### Path Parameters - **uuid** (string) - Required - The UUID of the route. ``` -------------------------------- ### Get Raw Measures of a Location Source: https://api.airgradient.com/public/docs/api/v1 Retrieves the 200 most recent raw sensor measurements for a location, or within a specified date range. ```APIDOC ## GET /public/api/v1/locations/{locationId}/measures/raw ### Description Gets the 200 most recent raw measures of a location or from a certain date range. The records are ordered by date descending. ### Method GET ### Endpoint /public/api/v1/locations/{locationId}/measures/raw ### Parameters #### Path Parameters - **locationId** (string) - Required - The ID of the location. #### Query Parameters - **from_date** (string) - Optional - The start date for the range (YYYY-MM-DD). - **to_date** (string) - Optional - The end date for the range (YYYY-MM-DD). ``` -------------------------------- ### Get Current Measures of Public Location Source: https://api.airgradient.com/public/docs/api/v1/swagger.json Retrieves the current sensor measurements for a specific location that has been made public globally. ```APIDOC ## GET /public/api/v1/world/locations/{locationId}/measures/current ### Description Gets the current measures of a certain location that is made public to the world. ### Method GET ### Endpoint /public/api/v1/world/locations/{locationId}/measures/current ### Parameters #### Path Parameters - **locationId** (number) - Required - The unique id of the location ### Request Example None ### Response #### Success Response (200) OK (schema: Measure) #### Error Response (401) Not authorized #### Error Response (404) No data available ``` -------------------------------- ### Get Route Measures By UUID Source: https://api.airgradient.com/public/docs/api/v1/swagger.json Retrieves a merged history of extended and standard measures for a specific route, identified by its UUID. The route must be shared for this operation to succeed. Results are sorted by timestamp in descending order. ```APIDOC ## GET /public/api/v1/routes/{uuid}/measures ### Description Gets merged measures history for a route by UUID. Returns a merged history of extended and standard measures for the route identified by UUID, sorted by timestamp descending. The route must be shared. ### Method GET ### Endpoint /public/api/v1/routes/{uuid}/measures #### Path Parameters - **uuid** (string) - Required - The unique uuid of the route ### Response #### Success Response (200) - **array** - An array of MergedMeasure objects. ``` -------------------------------- ### Ping Server Source: https://api.airgradient.com/public/docs/api/v1 Pings the server to check its availability. ```APIDOC ## GET /public/api/v1/ping ### Description Pings the server to check its availability. ### Method GET ### Endpoint /public/api/v1/ping ``` -------------------------------- ### Update LED Mode for a Location's Sensor Source: https://api.airgradient.com/public/docs/api/v1 Updates the LED mode configuration for a sensor at a specific location. ```APIDOC ## PUT /public/api/v1/locations/{locationId}/sensor/config/leds/mode ### Description Updates the led mode. ### Method PUT ### Endpoint /public/api/v1/locations/{locationId}/sensor/config/leds/mode ### Parameters #### Path Parameters - **locationId** (string) - Required - The ID of the location. #### Request Body - **mode** (string) - Required - The desired LED mode (e.g., 'on', 'off', 'auto'). ``` -------------------------------- ### Trigger CO2 Sensor Calibration for a Location Source: https://api.airgradient.com/public/docs/api/v1 Initiates the CO2 sensor calibration process for a specific location. ```APIDOC ## POST /public/api/v1/locations/{locationId}/sensor/co2/calibration ### Description Triggers calibration of the co2 sensor. ### Method POST ### Endpoint /public/api/v1/locations/{locationId}/sensor/co2/calibration ### Parameters #### Path Parameters - **locationId** (string) - Required - The ID of the location. ``` -------------------------------- ### Calibrate CO2 Sensor by Location ID Source: https://api.airgradient.com/public/docs/api/v1/swagger.json Triggers the calibration process for the CO2 sensor associated with a specific location. Ensure the sensor is in a 400ppm environment during calibration. ```APIDOC ## POST /public/api/v1/locations/{locationId}/sensor/co2/calibration ### Description Triggers calibration of the co2 sensor. Note that the sensor has to be in a 400ppm environment when calibration is performed. ### Method POST ### Endpoint /public/api/v1/locations/{locationId}/sensor/co2/calibration #### Path Parameters - **locationId** (number) - Required - The unique id of the location ### Response #### Success Response (200) - **OK** ``` -------------------------------- ### Update LED Mode by Location ID Source: https://api.airgradient.com/public/docs/api/v1/swagger.json Updates the LED mode configuration for a sensor at a specific location. Requires the new LED mode to be provided in the request body. ```APIDOC ## PUT /public/api/v1/locations/{locationId}/sensor/config/leds/mode ### Description Updates the led mode. ### Method PUT ### Endpoint /public/api/v1/locations/{locationId}/sensor/config/leds/mode #### Path Parameters - **locationId** (number) - Required - The unique id of the location #### Request Body - **body** (LedMode) - Required - The led mode. ### Response #### Success Response (200) - **LedMode** - The updated LED mode configuration. ``` -------------------------------- ### Trigger CO2 Sensor Calibration for a Sensor Source: https://api.airgradient.com/public/docs/api/v1 Initiates the CO2 sensor calibration process for a specific sensor, identified by its serial number. ```APIDOC ## POST /public/api/v1/sensors/{serialno}/co2/calibration ### Description Triggers calibration of the co2 sensor. ### Method POST ### Endpoint /public/api/v1/sensors/{serialno}/co2/calibration ### Parameters #### Path Parameters - **serialno** (string) - Required - The serial number of the sensor. ``` -------------------------------- ### Update LED Mode for a Sensor Source: https://api.airgradient.com/public/docs/api/v1 Updates the LED mode configuration for a specific sensor, identified by its serial number. ```APIDOC ## PUT /public/api/v1/sensors/{serialno}/config/leds/mode ### Description Updates the led mode. ### Method PUT ### Endpoint /public/api/v1/sensors/{serialno}/config/leds/mode ### Parameters #### Path Parameters - **serialno** (string) - Required - The serial number of the sensor. #### Request Body - **mode** (string) - Required - The desired LED mode (e.g., 'on', 'off', 'auto'). ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.