dimensions_request: Send request to the Dimensions API

In tilltnet/rdimensions: Access dimensions.ai API

Send request to the Dimensions API

Description

Requests can be for data or API self-description ('describe' or 'describe source ...'). With 'auto.extract = TRUE' the data will be returned as a list of 'data.frames'.

Usage

dimensions_request(
  dsl_query = "describe",
  session_token = getOption("dimensions_token"),
  fail_on_error = TRUE,
  describe = FALSE,
  auto.extract = TRUE
)

Arguments

dsl_query	'Character', expressing request using [Dimensions API DSL](https://docs.dimensions.ai/dsl/api.html).
session_token	'Character', Dimensions API session token.
fail_on_error	'Logical', TRUE: raise an error if HTTP request fails, FALSE: warn.
describe	‘Logical', set true if API self-description commands (’describe' or 'describe source ...') are used.
auto.extract	'Logical', determines if the received data is processed and returned as a list of 'data.frames'. If 'FALSE', data is returned as a nested list representing the JSON structure; 'extract_fields()' can be used to turn it into a list of 'data.frames'.

tilltnet/rdimensions documentation built on Sept. 14, 2023, 7:02 p.m.