get_configs: Retreive configurations for each data type in the GtR API.

View source: R/get_configs.R

get_configsR Documentation

Retreive configurations for each data type in the GtR API.

Description

Allows youto retrieve details of the data configuration for each type of entity (eg, project, organisation) in the GtR API. This information could be useful in helping you structure queries.

Usage

get_configs(resource)

Arguments

resource

Specify the type of data for which you want to retrieve the configuration. Names must be as per gtr_endpoints.

Value

A list holding two dataframes - one ('parameters') covering query parameters and another ('fields') holding details about the fields you return.


shanej90/gtR documentation built on March 20, 2022, 5:19 p.m.