Get the base API response for a data set's meta data

Get the metadata information for a data set available from the EES API.

Usage

get_meta_response(
  dataset_id,
  dataset_version = NULL,
  ees_environment = NULL,
  api_version = NULL,
  parse = TRUE,
  verbose = FALSE
)

Arguments

dataset_id: ID of data set to be connected to. This is required if the endpoint is one of "get-summary", "get-meta", "get-csv", "get-data" or "post-data"
dataset_version: Version of data set to be connected to
ees_environment: EES ees_environment to connect to: "dev", "test", "preprod" or "prod"
api_version: EES API version
parse: Parse result into structured list
verbose: Run with additional contextual messaging. Logical, default = FALSE

Value

Results of query to API meta data endpoint

Examples

get_meta_response(example_id())
#> $filters
#>      id             column          label hint
#> 1 arLPb establishment_type Type of school     
#>                                                                                                    options
#> 1 VN5XE, PEebW, 1Ti3Z, dt0Zw, Primary schools, Secondary schools, Special schools, Total, NA, NA, NA, TRUE
#> 
#> $indicators
#>      id                  column                              label
#> 1 dPe0Z   count_absent_sessions Number of overall absence sessions
#> 2 OBXCL        count_enrolments         Number of pupil enrolments
#> 3 7YFXo count_possible_sessions        Number of sessions possible
#>   decimalPlaces
#> 1             0
#> 2             0
#> 3             0
#> 
#> $geographicLevels
#>   code    label
#> 1  NAT National
#> 
#> $locations
#>   level.code level.label                   options
#> 1        NAT    National mRj9K, England, E92000001
#> 
#> $timePeriods
#>   code    period   label
#> 1   AY 2021/2022 2021/22
#> 2   AY 2022/2023 2022/23
#> 3   AY 2023/2024 2023/24
#>