PurpleAir_getGroupDetail: Retrieve all members of the specified group
In MazamaScience/AirSensor2: Process and Display Data from Air Quality Sensors

PurpleAir_getGroupDetail

R Documentation

Retrieve all members of the specified group

Description

Sends a request to the PurpleAirAPI API endpoint described at: https://api.purpleair.com/#api-groups-get-group-detail

Usage

PurpleAir_getGroupDetail(
  api_key = NULL,
  group_id = NULL,
  baseUrl = "https://api.purpleair.com/v1/groups"
)

Arguments

`api_key`	PurpleAir API READ key.
`group_id`	The `group_id` of the requested group. This group must be owned by the `api_key`.
`baseUrl`	URL endpoint for the "Get Group Detail" API.

Value

List containing all members of the specified group.

Examples


# Fail gracefully if any resources are not available
try({

library(AirSensor2)

  PurpleAir_getGroupDetail(
    api_key = PurpleAir_API_READ_KEY,
    group_id = MY_GROUP_ID
  )

}, silent = FALSE)

MazamaScience/AirSensor2 documentation built on Oct. 31, 2024, 1:39 a.m.