A valid request URL is required to generate request examples{
"results": {
"resolvedTimezone": "<string>",
"usedParametersValues": {},
"parameterReferences": [
"<string>"
],
"cacheMetadata": {
"cacheHit": true,
"preAggregate": {
"hit": true,
"reason": {
"reason": "no_pre_aggregates_defined"
},
"name": "<string>"
},
"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>",
"totalMode": "formula",
"type": "number",
"format": {
"type": "default",
"round": 123,
"separator": "default",
"currency": "<string>",
"compact": "auto",
"prefix": "<string>",
"suffix": "<string>",
"timeInterval": "RAW",
"custom": "<string>"
},
"index": 123
}
],
"limit": 123,
"sorts": [
{
"descending": true,
"fieldId": "<string>",
"pivotValues": [
{
"value": "<string>",
"reference": "<string>"
}
],
"nullsFirst": true
}
],
"filters": {
"tableCalculations": {
"or": [
{
"operator": "isNull",
"id": "<string>",
"target": {
"fieldId": "<string>"
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true
}
],
"id": "<string>"
},
"metrics": {
"or": [
{
"operator": "isNull",
"id": "<string>",
"target": {
"fieldId": "<string>"
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true
}
],
"id": "<string>"
},
"dimensions": {
"or": [
{
"operator": "isNull",
"id": "<string>",
"target": {
"fieldId": "<string>"
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true
}
],
"id": "<string>"
}
},
"metrics": [
"<string>"
],
"dimensions": [
"<string>"
],
"exploreName": "<string>",
"metadata": {
"hasADateDimension": {
"name": "<string>",
"label": "<string>",
"table": "<string>"
}
},
"pivotDimensions": [
"<string>"
],
"timezone": "<string>",
"dimensionOverrides": {},
"metricOverrides": {},
"customDimensions": [
{
"id": "<string>",
"name": "<string>",
"table": "<string>",
"type": "bin",
"dimensionId": "<string>",
"binType": "fixed_number",
"binNumber": 123
}
],
"additionalMetrics": [
{
"type": "percentile",
"sql": "<string>",
"table": "<string>",
"name": "<string>",
"label": "<string>",
"description": "<string>",
"hidden": true,
"round": 123,
"compact": "auto",
"format": "km",
"separator": "default",
"index": 123,
"filters": [
{
"operator": "isNull",
"id": "<string>",
"target": {
"fieldRef": "<string>"
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true
}
],
"baseDimensionName": "<string>",
"baseMetricName": "<string>",
"uuid": "<string>",
"percentile": 123,
"distinctKeys": [
"<string>"
],
"formatOptions": {
"type": "default",
"round": 123,
"separator": "default",
"currency": "<string>",
"compact": "auto",
"prefix": "<string>",
"suffix": "<string>",
"timeInterval": "RAW",
"custom": "<string>"
},
"generationType": "periodOverPeriod",
"baseMetricId": "<string>",
"timeDimensionId": "<string>",
"granularity": "RAW",
"periodOffset": 123
}
]
}
},
"status": "ok"
}{
"error": {
"name": "<string>",
"statusCode": 123,
"data": "<unknown>",
"message": "<string>"
},
"status": "error"
}Run merge query
Run a merge, returning a query uuid to page results from.
The merged statement is registered as an ordinary async query, so its results are fetched, formatted, cancelled and downloaded through the same endpoints as any other query — page them with GET /api/v2/projects//query/.
A merge that cannot be run is rejected here rather than returned: compile it first to show the problem against the query that caused it.
A valid request URL is required to generate request examples{
"results": {
"resolvedTimezone": "<string>",
"usedParametersValues": {},
"parameterReferences": [
"<string>"
],
"cacheMetadata": {
"cacheHit": true,
"preAggregate": {
"hit": true,
"reason": {
"reason": "no_pre_aggregates_defined"
},
"name": "<string>"
},
"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>",
"totalMode": "formula",
"type": "number",
"format": {
"type": "default",
"round": 123,
"separator": "default",
"currency": "<string>",
"compact": "auto",
"prefix": "<string>",
"suffix": "<string>",
"timeInterval": "RAW",
"custom": "<string>"
},
"index": 123
}
],
"limit": 123,
"sorts": [
{
"descending": true,
"fieldId": "<string>",
"pivotValues": [
{
"value": "<string>",
"reference": "<string>"
}
],
"nullsFirst": true
}
],
"filters": {
"tableCalculations": {
"or": [
{
"operator": "isNull",
"id": "<string>",
"target": {
"fieldId": "<string>"
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true
}
],
"id": "<string>"
},
"metrics": {
"or": [
{
"operator": "isNull",
"id": "<string>",
"target": {
"fieldId": "<string>"
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true
}
],
"id": "<string>"
},
"dimensions": {
"or": [
{
"operator": "isNull",
"id": "<string>",
"target": {
"fieldId": "<string>"
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true
}
],
"id": "<string>"
}
},
"metrics": [
"<string>"
],
"dimensions": [
"<string>"
],
"exploreName": "<string>",
"metadata": {
"hasADateDimension": {
"name": "<string>",
"label": "<string>",
"table": "<string>"
}
},
"pivotDimensions": [
"<string>"
],
"timezone": "<string>",
"dimensionOverrides": {},
"metricOverrides": {},
"customDimensions": [
{
"id": "<string>",
"name": "<string>",
"table": "<string>",
"type": "bin",
"dimensionId": "<string>",
"binType": "fixed_number",
"binNumber": 123
}
],
"additionalMetrics": [
{
"type": "percentile",
"sql": "<string>",
"table": "<string>",
"name": "<string>",
"label": "<string>",
"description": "<string>",
"hidden": true,
"round": 123,
"compact": "auto",
"format": "km",
"separator": "default",
"index": 123,
"filters": [
{
"operator": "isNull",
"id": "<string>",
"target": {
"fieldRef": "<string>"
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true
}
],
"baseDimensionName": "<string>",
"baseMetricName": "<string>",
"uuid": "<string>",
"percentile": 123,
"distinctKeys": [
"<string>"
],
"formatOptions": {
"type": "default",
"round": 123,
"separator": "default",
"currency": "<string>",
"compact": "auto",
"prefix": "<string>",
"suffix": "<string>",
"timeInterval": "RAW",
"custom": "<string>"
},
"generationType": "periodOverPeriod",
"baseMetricId": "<string>",
"timeDimensionId": "<string>",
"granularity": "RAW",
"periodOffset": 123
}
]
}
},
"status": "ok"
}{
"error": {
"name": "<string>",
"statusCode": 123,
"data": "<unknown>",
"message": "<string>"
},
"status": "error"
}Path Parameters
Body
Body of the run endpoint. The pivot configuration is the same one every other query runs with: the merged rows are wrapped by the standard pivot stage, so the pipeline is join within an explore, then merge between explores, then pivot.
Show child attributes
Show child attributes
Parameter values for every source query, one map for the whole merge — two sides of one question should never disagree on a parameter.
Show child attributes
Show child attributes
Export row limit. Null means all rows within the organization's cell cap.
Show child attributes
Show child attributes
Was this page helpful?