A valid request URL is required to generate request examples{
"results": {
"usedParametersValues": {},
"parameterReferences": [
"<string>"
],
"cacheMetadata": {
"cacheHit": true,
"cacheKey": "<string>",
"cacheExpiresAt": "2023-11-07T05:31:56Z",
"cacheUpdatedTime": "2023-11-07T05:31:56Z"
},
"queryUuid": "<string>",
"warnings": [
{
"message": "<string>",
"tables": [
"<string>"
],
"fields": [
"<string>"
]
}
],
"fields": {},
"metricQuery": {
"tableCalculations": [
{
"displayName": "<string>",
"name": "<string>",
"sql": "<string>",
"type": "number",
"format": {
"type": "default",
"round": 123,
"separator": "default",
"currency": "<string>",
"compact": "thousands",
"prefix": "<string>",
"suffix": "<string>",
"timeInterval": "RAW",
"custom": "<string>"
},
"index": 123
}
],
"limit": 123,
"sorts": [
{
"descending": true,
"fieldId": "<string>",
"nullsFirst": true
}
],
"filters": {
"tableCalculations": {
"or": [
"<unknown>"
],
"id": "<string>"
},
"metrics": {
"or": [
"<unknown>"
],
"id": "<string>"
},
"dimensions": {
"or": [
"<unknown>"
],
"id": "<string>"
}
},
"metrics": [
"<string>"
],
"dimensions": [
"<string>"
],
"exploreName": "<string>",
"periodOverPeriod": {
"granularity": "RAW",
"type": "previousPeriod",
"field": {
"table": "<string>",
"name": "<string>"
},
"periodOffset": 123
},
"metadata": {
"hasADateDimension": {
"name": "<string>",
"label": "<string>",
"table": "<string>"
}
},
"timezone": "<string>",
"metricOverrides": {},
"customDimensions": [
{
"id": "<string>",
"name": "<string>",
"table": "<string>",
"type": "bin",
"dimensionId": "<string>",
"binType": "fixed_number",
"binNumber": 123,
"binWidth": 123,
"customRange": [
{
"to": 123,
"from": 123
}
]
}
],
"additionalMetrics": [
{
"type": "percentile",
"sql": "<string>",
"table": "<string>",
"name": "<string>",
"label": "<string>",
"description": "<string>",
"hidden": true,
"round": 123,
"compact": "thousands",
"format": "km",
"index": 123,
"filters": [
{
"operator": "isNull",
"id": "<string>",
"target": {
"fieldRef": "<string>"
},
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true
}
],
"baseDimensionName": "<string>",
"uuid": "<string>",
"percentile": 123,
"formatOptions": {
"type": "default",
"round": 123,
"separator": "default",
"currency": "<string>",
"compact": "thousands",
"prefix": "<string>",
"suffix": "<string>",
"timeInterval": "RAW",
"custom": "<string>"
}
}
]
}
},
"status": "ok"
}Execute underlying data
Executes a query to retrieve underlying raw data for drilling down into aggregated values
A valid request URL is required to generate request examples{
"results": {
"usedParametersValues": {},
"parameterReferences": [
"<string>"
],
"cacheMetadata": {
"cacheHit": true,
"cacheKey": "<string>",
"cacheExpiresAt": "2023-11-07T05:31:56Z",
"cacheUpdatedTime": "2023-11-07T05:31:56Z"
},
"queryUuid": "<string>",
"warnings": [
{
"message": "<string>",
"tables": [
"<string>"
],
"fields": [
"<string>"
]
}
],
"fields": {},
"metricQuery": {
"tableCalculations": [
{
"displayName": "<string>",
"name": "<string>",
"sql": "<string>",
"type": "number",
"format": {
"type": "default",
"round": 123,
"separator": "default",
"currency": "<string>",
"compact": "thousands",
"prefix": "<string>",
"suffix": "<string>",
"timeInterval": "RAW",
"custom": "<string>"
},
"index": 123
}
],
"limit": 123,
"sorts": [
{
"descending": true,
"fieldId": "<string>",
"nullsFirst": true
}
],
"filters": {
"tableCalculations": {
"or": [
"<unknown>"
],
"id": "<string>"
},
"metrics": {
"or": [
"<unknown>"
],
"id": "<string>"
},
"dimensions": {
"or": [
"<unknown>"
],
"id": "<string>"
}
},
"metrics": [
"<string>"
],
"dimensions": [
"<string>"
],
"exploreName": "<string>",
"periodOverPeriod": {
"granularity": "RAW",
"type": "previousPeriod",
"field": {
"table": "<string>",
"name": "<string>"
},
"periodOffset": 123
},
"metadata": {
"hasADateDimension": {
"name": "<string>",
"label": "<string>",
"table": "<string>"
}
},
"timezone": "<string>",
"metricOverrides": {},
"customDimensions": [
{
"id": "<string>",
"name": "<string>",
"table": "<string>",
"type": "bin",
"dimensionId": "<string>",
"binType": "fixed_number",
"binNumber": 123,
"binWidth": 123,
"customRange": [
{
"to": 123,
"from": 123
}
]
}
],
"additionalMetrics": [
{
"type": "percentile",
"sql": "<string>",
"table": "<string>",
"name": "<string>",
"label": "<string>",
"description": "<string>",
"hidden": true,
"round": 123,
"compact": "thousands",
"format": "km",
"index": 123,
"filters": [
{
"operator": "isNull",
"id": "<string>",
"target": {
"fieldRef": "<string>"
},
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true
}
],
"baseDimensionName": "<string>",
"uuid": "<string>",
"percentile": 123,
"formatOptions": {
"type": "default",
"round": 123,
"separator": "default",
"currency": "<string>",
"compact": "thousands",
"prefix": "<string>",
"suffix": "<string>",
"timeInterval": "RAW",
"custom": "<string>"
}
}
]
}
},
"status": "ok"
}Path Parameters
Body
Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
isNull, notNull, equals, notEquals, startsWith, endsWith, include, doesNotInclude, lessThan, lessThanOrEqual, greaterThan, greaterThanOrEqual, inThePast, notInThePast, inTheNext, inTheCurrent, notInTheCurrent, inBetween, notInBetween This AnyType is an alias for any
The goal is to make it easier to identify any type in the codebase
without having to eslint-disable all the time
These are only used on legacy any types, don't use it for new types.
This is added on a separate file to avoid circular dependencies.
This AnyType is an alias for any
The goal is to make it easier to identify any type in the codebase
without having to eslint-disable all the time
These are only used on legacy any types, don't use it for new types.
This is added on a separate file to avoid circular dependencies.
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
isNull, notNull, equals, notEquals, startsWith, endsWith, include, doesNotInclude, lessThan, lessThanOrEqual, greaterThan, greaterThanOrEqual, inThePast, notInThePast, inTheNext, inTheCurrent, notInTheCurrent, inBetween, notInBetween This AnyType is an alias for any
The goal is to make it easier to identify any type in the codebase
without having to eslint-disable all the time
These are only used on legacy any types, don't use it for new types.
This is added on a separate file to avoid circular dependencies.
This AnyType is an alias for any
The goal is to make it easier to identify any type in the codebase
without having to eslint-disable all the time
These are only used on legacy any types, don't use it for new types.
This is added on a separate file to avoid circular dependencies.
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
isNull, notNull, equals, notEquals, startsWith, endsWith, include, doesNotInclude, lessThan, lessThanOrEqual, greaterThan, greaterThanOrEqual, inThePast, notInThePast, inTheNext, inTheCurrent, notInTheCurrent, inBetween, notInBetween This AnyType is an alias for any
The goal is to make it easier to identify any type in the codebase
without having to eslint-disable all the time
These are only used on legacy any types, don't use it for new types.
This is added on a separate file to avoid circular dependencies.
This AnyType is an alias for any
The goal is to make it easier to identify any type in the codebase
without having to eslint-disable all the time
These are only used on legacy any types, don't use it for new types.
This is added on a separate file to avoid circular dependencies.
dashboardView, autorefreshedDashboard, exploreView, filterAutocomplete, chartView, chartHistory, sqlChartView, sqlRunner, viewUnderlyingData, alert, scheduledDelivery, csvDownload, gsheets, scheduledGsheetsChart, scheduledGsheetsDashboard, scheduledChart, scheduledDashboard, calculateTotal, calculateSubtotal, embed, ai, mcp, api, cli, metricsExplorer Response
Success
Show child attributes
Show child attributes
Construct a type with a set of properties K of type T
Show child attributes
Show child attributes
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Show child attributes
Show child attributes
metric, dimension Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
thousands, millions, billions, trillions, kilobytes, megabytes, gigabytes, terabytes, petabytes, kibibytes, mebibytes, gibibytes, tebibytes, pebibytes km, mi, usd, gbp, eur, jpy, dkk, id, percent Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
number, string, date, timestamp, boolean Show child attributes
Show child attributes
default, percent, currency, number, id, date, timestamp, bytes_si, bytes_iec, custom default, commaPeriod, spacePeriod, periodComma, noSeparatorPeriod thousands, millions, billions, trillions, kilobytes, megabytes, gigabytes, terabytes, petabytes, kibibytes, mebibytes, gibibytes, tebibytes, pebibytes RAW, YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND, DAY_OF_WEEK_INDEX, DAY_OF_MONTH_NUM, DAY_OF_YEAR_NUM, WEEK_NUM, MONTH_NUM, QUARTER_NUM, YEAR_NUM, DAY_OF_WEEK_NAME, MONTH_NAME, QUARTER_NAME, HOUR_OF_DAY_NUM, MINUTE_OF_HOUR_NUM Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
isNull, notNull, equals, notEquals, startsWith, endsWith, include, doesNotInclude, lessThan, lessThanOrEqual, greaterThan, greaterThanOrEqual, inThePast, notInThePast, inTheNext, inTheCurrent, notInTheCurrent, inBetween, notInBetween This AnyType is an alias for any
The goal is to make it easier to identify any type in the codebase
without having to eslint-disable all the time
These are only used on legacy any types, don't use it for new types.
This is added on a separate file to avoid circular dependencies.
This AnyType is an alias for any
The goal is to make it easier to identify any type in the codebase
without having to eslint-disable all the time
These are only used on legacy any types, don't use it for new types.
This is added on a separate file to avoid circular dependencies.
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
isNull, notNull, equals, notEquals, startsWith, endsWith, include, doesNotInclude, lessThan, lessThanOrEqual, greaterThan, greaterThanOrEqual, inThePast, notInThePast, inTheNext, inTheCurrent, notInTheCurrent, inBetween, notInBetween This AnyType is an alias for any
The goal is to make it easier to identify any type in the codebase
without having to eslint-disable all the time
These are only used on legacy any types, don't use it for new types.
This is added on a separate file to avoid circular dependencies.
This AnyType is an alias for any
The goal is to make it easier to identify any type in the codebase
without having to eslint-disable all the time
These are only used on legacy any types, don't use it for new types.
This is added on a separate file to avoid circular dependencies.
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
isNull, notNull, equals, notEquals, startsWith, endsWith, include, doesNotInclude, lessThan, lessThanOrEqual, greaterThan, greaterThanOrEqual, inThePast, notInThePast, inTheNext, inTheCurrent, notInTheCurrent, inBetween, notInBetween This AnyType is an alias for any
The goal is to make it easier to identify any type in the codebase
without having to eslint-disable all the time
These are only used on legacy any types, don't use it for new types.
This is added on a separate file to avoid circular dependencies.
This AnyType is an alias for any
The goal is to make it easier to identify any type in the codebase
without having to eslint-disable all the time
These are only used on legacy any types, don't use it for new types.
This is added on a separate file to avoid circular dependencies.
Show child attributes
Show child attributes
RAW, YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND, DAY_OF_WEEK_INDEX, DAY_OF_MONTH_NUM, DAY_OF_YEAR_NUM, WEEK_NUM, MONTH_NUM, QUARTER_NUM, YEAR_NUM, DAY_OF_WEEK_NAME, MONTH_NAME, QUARTER_NAME, HOUR_OF_DAY_NUM, MINUTE_OF_HOUR_NUM previousPeriod Show child attributes
Show child attributes
Show child attributes
Show child attributes
From T, pick a set of properties whose keys are in the union K
Show child attributes
Show child attributes
Show child attributes
Show child attributes
default, percent, currency, number, id, date, timestamp, bytes_si, bytes_iec, custom default, commaPeriod, spacePeriod, periodComma, noSeparatorPeriod thousands, millions, billions, trillions, kilobytes, megabytes, gigabytes, terabytes, petabytes, kibibytes, mebibytes, gibibytes, tebibytes, pebibytes RAW, YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND, DAY_OF_WEEK_INDEX, DAY_OF_MONTH_NUM, DAY_OF_YEAR_NUM, WEEK_NUM, MONTH_NUM, QUARTER_NUM, YEAR_NUM, DAY_OF_WEEK_NAME, MONTH_NAME, QUARTER_NAME, HOUR_OF_DAY_NUM, MINUTE_OF_HOUR_NUM - Option 1
- Option 2
Show child attributes
Show child attributes
bin fixed_number, fixed_width, custom_range Show child attributes
Show child attributes
percentile, average, count, count_distinct, sum, min, max, percent_of_previous, percent_of_total, running_total, number, median, string, date, timestamp, boolean thousands, millions, billions, trillions, kilobytes, megabytes, gigabytes, terabytes, petabytes, kibibytes, mebibytes, gibibytes, tebibytes, pebibytes km, mi, usd, gbp, eur, jpy, dkk, id, percent Show child attributes
Show child attributes
isNull, notNull, equals, notEquals, startsWith, endsWith, include, doesNotInclude, lessThan, lessThanOrEqual, greaterThan, greaterThanOrEqual, inThePast, notInThePast, inTheNext, inTheCurrent, notInTheCurrent, inBetween, notInBetween This AnyType is an alias for any
The goal is to make it easier to identify any type in the codebase
without having to eslint-disable all the time
These are only used on legacy any types, don't use it for new types.
This is added on a separate file to avoid circular dependencies.
This AnyType is an alias for any
The goal is to make it easier to identify any type in the codebase
without having to eslint-disable all the time
These are only used on legacy any types, don't use it for new types.
This is added on a separate file to avoid circular dependencies.
Show child attributes
Show child attributes
default, percent, currency, number, id, date, timestamp, bytes_si, bytes_iec, custom default, commaPeriod, spacePeriod, periodComma, noSeparatorPeriod thousands, millions, billions, trillions, kilobytes, megabytes, gigabytes, terabytes, petabytes, kibibytes, mebibytes, gibibytes, tebibytes, pebibytes RAW, YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND, DAY_OF_WEEK_INDEX, DAY_OF_MONTH_NUM, DAY_OF_YEAR_NUM, WEEK_NUM, MONTH_NUM, QUARTER_NUM, YEAR_NUM, DAY_OF_WEEK_NAME, MONTH_NAME, QUARTER_NAME, HOUR_OF_DAY_NUM, MINUTE_OF_HOUR_NUM ok Was this page helpful?