analytics_query: Query the FDW Parameters / Constants / 'Analytics' with an R...

View source: R/analytics_query.R

analytics_queryR Documentation

Query the FDW Parameters / Constants / 'Analytics' with an R list defining the query. This form of the query expects you to pass in the json query in the form of an R list.

Description

Query the FDW Parameters / Constants / 'Analytics' with an R list defining the query. This form of the query expects you to pass in the json query in the form of an R list.

Usage

analytics_query(
  flight_id,
  query_list,
  efoqa_connection = connect_to_efoqa(),
  start_offset = NULL,
  end_offset = NULL,
  coerce_types = TRUE
)

Arguments

flight_id

The numeric flight record id to target

query_list

list format of the query to perform. See API documentation for details.

efoqa_connection

An optional efoqa connection list object for re-use or customization.

start_offset

Request data starting at some offset

end_offset

Request data ending at some offset

coerce_types

Set this to FALSE to get all results back as strings. This will improve speed a little bit since no metadata queries will be required.

Value

A list object with the results of the analytics query.

Examples

## Not run: 
query_list_example <- list(
   select = list( list( analyticID = analytic_id_1), list( analyticID = analytic_id_2 ) )
   )

analytics_query(3135409, query_list_example)

## End(Not run)

ge-flight-analytics/refoqa documentation built on Oct. 15, 2024, 7:15 a.m.