Sign in

v1

latestOpenAPI 3.1.02026-07-133535147.2 KB
CalculationsModule

Route Merge

Merge endpoint.

get/calcs/merge.{extension}

Path parameters

extension'csv' | 'csvbom' | 'xlsx' | 'jsonarrays' | 'jsonrecords' | 'parquet' | 'tsv' | 'tsvbom' required

Define the extensions available to the user and how to response to them.

Query parameters

cube_leftstring required

Cube to retrieve part of the data

drilldowns_leftstring[] required

A list of the level names to slice the bulk of the aggregated data.

measures_leftstring[] required

Quantitative variable

include_leftobject

Limits the results returned by the output. Only members of the declared Level will be considered in the data.

exclude_leftobject

Limits the results returned by the output. Members of the declared Level won't be considered in the data.

cube_rightstring required

The cube to retrieve the main data

drilldowns_rightstring[] required

Cube to retrieve part of the data

measures_rightstring[] required

Quantitative variable

include_rightobject

Limits the results returned by the output. Only members of the declared Level will be considered in the data.

exclude_rightobject

Limits the results returned by the output. Members of the declared Level won't be considered in the data.

timestring nullable

Specifies the time period to filter the data by

localestring nullable

Defines the locale variation for the labels in the data

{
  "cube_left": "ipeds_ic_living_expenses",
  "cube_right": "ipeds_tuition",
  "locale": "en"
}
tokenstring nullable
filtersstring
topstring

Headers

authorizationstring nullable
x-tesseract-jwtstring nullable

Response

Successful Response

{"stackTrail":"paths:/calcs/merge.{extension}:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}