Sign in

v1

latestOpenAPI 3.1.02026-07-133535147.2 KB
CalculationsModule

Route Pums

PUMS calculation endpoint.

get/calcs/pums.{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

cubestring required

The cube to retrieve the main data

drilldownsstring[] required

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

measuresstring[] required

Quantitative variable

includeobject

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

excludeobject

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

localestring nullable

Defines the locale variation for the labels in the data

parentsboolean

Specifies if the response items should include the parent levels for activity and location.

{
  "cube": "pums_1",
  "locale": "en"
}
tokenstring nullable
filtersstring
topstring

Headers

authorizationstring nullable
x-tesseract-jwtstring nullable

Response

Successful Response

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