v1

latestOpenAPI 3.1.02026-07-133535147.2 KB
TesseractModule

Debug Sql

Return the generated SQL query for the same parameters of a data request.

get/tesseract/debug/query

Query parameters

cubestring required

The name of the cube to work with.

The name of the cube to work with.

drilldownsstring required

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

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

measuresstring required

A list of the measure names to retrieve from the aggregated data.

A list of the measure names to retrieve from the aggregated data.

aliasesstring nullable
localestring nullable
limitstring

Specifies pagination on the results, so the query can be separated in multiple requests.

The shape of the parameter is composed by one integer, or two integers separated by a comma: {value} := {limit} | {limit},{offset} Where: {limit} : int, defines the max amount of items in the response data {offset} : int, defines the index of the first item in the full list where the list in the response data will start.

Specifies pagination on the results, so the query can be separated in multiple requests.

The shape of the parameter is composed by one integer, or two integers separated by a comma: {value} := {limit} | {limit},{offset} Where: {limit} : int, defines the max amount of items in the response data {offset} : int, defines the index of the first item in the full list where the list in the response data will start.

parentsstring

Specifies if the request should include the labels for the parent levels of the selected drilldowns.

The shape for the value is: {value} := {truthy} | {falsey} | {name},{name...} Where: {truthy} : A string that can be interpreted as a truthy value; retrieves parents for all drilldowns in the request; {falsey} : A string that can be interpreted as a falsey value; deactivates parents for all drilldowns in the request (default); {name} : str, the name of the specific drilldown(s) to get parents for.

Specifies if the request should include the labels for the parent levels of the selected drilldowns.

The shape for the value is: {value} := {truthy} | {falsey} | {name},{name...} Where: {truthy} : A string that can be interpreted as a truthy value; retrieves parents for all drilldowns in the request; {falsey} : A string that can be interpreted as a falsey value; deactivates parents for all drilldowns in the request (default); {name} : str, the name of the specific drilldown(s) to get parents for.

propertiesstring nullable
rankingstring

Adds a Ranking column to the specified measures.

If unset, or set to a value that can be interpreted as falsey, no rankings are added. If set to a value that can be interpreted as truthy, a ranking for every measure is added. Any other string is interpreted as a comma-separated list of the measure names that are expected to be added a ranking.

The value is always an unsigned integer. If many rows have an equal value, all are assigned the same ranking value, and the next value skips the places for the repeated rows. The direction of the ranking can be specified by (not) prefixing the measure name with a minus character (-): the ranking will be calculated in descending order if the minus is present, ascending otherwise.

Adds a Ranking column to the specified measures.

If unset, or set to a value that can be interpreted as falsey, no rankings are added. If set to a value that can be interpreted as truthy, a ranking for every measure is added. Any other string is interpreted as a comma-separated list of the measure names that are expected to be added a ranking.

The value is always an unsigned integer. If many rows have an equal value, all are assigned the same ranking value, and the next value skips the places for the repeated rows. The direction of the ranking can be specified by (not) prefixing the measure name with a minus character (-): the ranking will be calculated in descending order if the minus is present, ascending otherwise.

sortstring

Specifies the order of the results; available for properties and measures included in the request.

The shape for the value is: {value} := {field} | {field}.{order} Where: {field} : str, defines the field to use: Measure or Property {order} : Literal["asc", "desc"], defines the direction to sort the dataset

The field will be resolved to a Measure first, if not found then to a Property. When {order} is not set, "asc" will be used by default.

Specifies the order of the results; available for properties and measures included in the request.

The shape for the value is: {value} := {field} | {field}.{order} Where: {field} : str, defines the field to use: Measure or Property {order} : Literal["asc", "desc"], defines the direction to sort the dataset

The field will be resolved to a Measure first, if not found then to a Property. When {order} is not set, "asc" will be used by default.

timestring nullable
topstring nullable
growthstring nullable
excludestring

Specifies which values should be omitted from the aggregation.

The value is composed by multiple cut definitions separated by semicolons: {value} := {cut_def};{cut_def...} Where a single cut definition is composed by the Level name, colon, and the list of keys separated by commas: {cut_def} := {name}:{key},{key...} {name} : str, the name of the Level to apply the cut {key} : str | int, the members' ID values

Specifies which values should be omitted from the aggregation.

The value is composed by multiple cut definitions separated by semicolons: {value} := {cut_def};{cut_def...} Where a single cut definition is composed by the Level name, colon, and the list of keys separated by commas: {cut_def} := {name}:{key},{key...} {name} : str, the name of the Level to apply the cut {key} : str | int, the members' ID values

includestring

Specifies which values should be considered for the aggregation.

The value is composed by multiple cut definitions separated by semicolons: {value} := {cut_def};{cut_def...} Where a single cut definition is composed by the Level name, colon, and the list of keys separated by commas: {cut_def} := {name}:{key},{key...} {name} : str, the name of the Level to apply the cut {key} : str | int, the members' ID values

For compatibility, this parameter also accepts the definition of the {name} parameter directly in the URL search params; note the level name must start in caps for this to work. This means both &include=Year:2009,2010 and &Year=2009,2010 are equivalent.

Specifies which values should be considered for the aggregation.

The value is composed by multiple cut definitions separated by semicolons: {value} := {cut_def};{cut_def...} Where a single cut definition is composed by the Level name, colon, and the list of keys separated by commas: {cut_def} := {name}:{key},{key...} {name} : str, the name of the Level to apply the cut {key} : str | int, the members' ID values

For compatibility, this parameter also accepts the definition of the {name} parameter directly in the URL search params; note the level name must start in caps for this to work. This means both &include=Year:2009,2010 and &Year=2009,2010 are equivalent.

filtersstring[]

Specifies filters over the values of the calculated aggregations.

The value is a list of filter parameters, where each is composed by a measure name, and one or two conditions: {value} := {filter},{filter...} {filter} := {name}.{condition} | {name}.{condition}.{joint}.{condition} {condition} := {comparison}.{number} Where {name} : str, the name of the Measure to apply the filter on; {comparison}: Literal["gt", "gte", "eq", "neq", "lt", "lte"], the comparison operation to evaluate ('g' is 'greater', 'l' is 'lower', 'eq' is 'equal', 'neq' is 'not equal'); {number} : float, the value to apply the comparison against the Measure (using decimal dot); {joint} : Literal["and", "or"], the logic operation to apply between two conditions;

Specifies filters over the values of the calculated aggregations.

The value is a list of filter parameters, where each is composed by a measure name, and one or two conditions: {value} := {filter},{filter...} {filter} := {name}.{condition} | {name}.{condition}.{joint}.{condition} {condition} := {comparison}.{number} Where {name} : str, the name of the Measure to apply the filter on; {comparison}: Literal["gt", "gte", "eq", "neq", "lt", "lte"], the comparison operation to evaluate ('g' is 'greater', 'l' is 'lower', 'eq' is 'equal', 'neq' is 'not equal'); {number} : float, the value to apply the comparison against the Measure (using decimal dot); {joint} : Literal["and", "or"], the logic operation to apply between two conditions;

tokenstring nullable

Headers

Acceptstring required
authorizationstring nullable
x-tesseract-jwtstring nullable

Response

Successful Response

{"stackTrail":"paths:/tesseract/debug/query:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}