Retrieve query execution plan by ID
curl --request GET \
--url https://{host}/activeviam/query-history/rest/v1/query/{id}/query-planimport requests
url = "https://{host}/activeviam/query-history/rest/v1/query/{id}/query-plan"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://{host}/activeviam/query-history/rest/v1/query/{id}/query-plan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/activeviam/query-history/rest/v1/query/{id}/query-plan",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{host}/activeviam/query-history/rest/v1/query/{id}/query-plan"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{host}/activeviam/query-history/rest/v1/query/{id}/query-plan")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/activeviam/query-history/rest/v1/query/{id}/query-plan")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body[
{
"aggregateRetrievals": [
{
"filterId": 123,
"horizontalDispatching": {
"dispatchingPerApplication": [
{
"applicationName": "<string>",
"dispatchingPerLevel": {}
}
]
},
"location": [
{
"dimension": "<string>",
"hierarchy": "<string>",
"level": [
"<string>"
],
"path": [
"<unknown>"
]
}
],
"measureProvider": "<string>",
"measures": [
"<string>"
],
"measuresData": [
{
"name": "<string>"
}
],
"partialProviderName": "<string>",
"partitioning": "<string>",
"resultSizes": [
123
],
"retrievalId": 123,
"timingInfo": {},
"type": "<string>",
"underlyingDataNodes": [
"<string>"
],
"underlyingRetrievalType": "<string>"
}
],
"databaseDependencies": {},
"databaseRetrievals": [
{
"condition": "<string>",
"fields": [
"<string>"
],
"joinedMeasure": [
"<string>"
],
"resultSizes": [
123
],
"retrievalId": 123,
"store": "<string>",
"timingInfo": {}
}
],
"dependencies": {},
"planInfo": "<unknown>",
"queryFilters": [
{
"description": "<string>",
"id": 123
}
],
"querySummary": {
"measures": [
"<string>"
],
"partialProviders": [
"<string>"
],
"partitioningCountByType": {},
"resultSizeByPartitioning": {},
"retrievalsCountByType": {},
"totalDatabaseResultSize": 123,
"totalRetrievals": 123
}
}
][
{
"aggregateRetrievals": [
{
"filterId": 123,
"horizontalDispatching": {
"dispatchingPerApplication": [
{
"applicationName": "<string>",
"dispatchingPerLevel": {}
}
]
},
"location": [
{
"dimension": "<string>",
"hierarchy": "<string>",
"level": [
"<string>"
],
"path": [
"<unknown>"
]
}
],
"measureProvider": "<string>",
"measures": [
"<string>"
],
"measuresData": [
{
"name": "<string>"
}
],
"partialProviderName": "<string>",
"partitioning": "<string>",
"resultSizes": [
123
],
"retrievalId": 123,
"timingInfo": {},
"type": "<string>",
"underlyingDataNodes": [
"<string>"
],
"underlyingRetrievalType": "<string>"
}
],
"databaseDependencies": {},
"databaseRetrievals": [
{
"condition": "<string>",
"fields": [
"<string>"
],
"joinedMeasure": [
"<string>"
],
"resultSizes": [
123
],
"retrievalId": 123,
"store": "<string>",
"timingInfo": {}
}
],
"dependencies": {},
"planInfo": "<unknown>",
"queryFilters": [
{
"description": "<string>",
"id": 123
}
],
"querySummary": {
"measures": [
"<string>"
],
"partialProviders": [
"<string>"
],
"partitioningCountByType": {},
"resultSizeByPartitioning": {},
"retrievalsCountByType": {},
"totalDatabaseResultSize": 123,
"totalRetrievals": 123
}
}
][
{
"aggregateRetrievals": [
{
"filterId": 123,
"horizontalDispatching": {
"dispatchingPerApplication": [
{
"applicationName": "<string>",
"dispatchingPerLevel": {}
}
]
},
"location": [
{
"dimension": "<string>",
"hierarchy": "<string>",
"level": [
"<string>"
],
"path": [
"<unknown>"
]
}
],
"measureProvider": "<string>",
"measures": [
"<string>"
],
"measuresData": [
{
"name": "<string>"
}
],
"partialProviderName": "<string>",
"partitioning": "<string>",
"resultSizes": [
123
],
"retrievalId": 123,
"timingInfo": {},
"type": "<string>",
"underlyingDataNodes": [
"<string>"
],
"underlyingRetrievalType": "<string>"
}
],
"databaseDependencies": {},
"databaseRetrievals": [
{
"condition": "<string>",
"fields": [
"<string>"
],
"joinedMeasure": [
"<string>"
],
"resultSizes": [
123
],
"retrievalId": 123,
"store": "<string>",
"timingInfo": {}
}
],
"dependencies": {},
"planInfo": "<unknown>",
"queryFilters": [
{
"description": "<string>",
"id": 123
}
],
"querySummary": {
"measures": [
"<string>"
],
"partialProviders": [
"<string>"
],
"partitioningCountByType": {},
"resultSizeByPartitioning": {},
"retrievalsCountByType": {},
"totalDatabaseResultSize": 123,
"totalRetrievals": 123
}
}
][
{
"aggregateRetrievals": [
{
"filterId": 123,
"horizontalDispatching": {
"dispatchingPerApplication": [
{
"applicationName": "<string>",
"dispatchingPerLevel": {}
}
]
},
"location": [
{
"dimension": "<string>",
"hierarchy": "<string>",
"level": [
"<string>"
],
"path": [
"<unknown>"
]
}
],
"measureProvider": "<string>",
"measures": [
"<string>"
],
"measuresData": [
{
"name": "<string>"
}
],
"partialProviderName": "<string>",
"partitioning": "<string>",
"resultSizes": [
123
],
"retrievalId": 123,
"timingInfo": {},
"type": "<string>",
"underlyingDataNodes": [
"<string>"
],
"underlyingRetrievalType": "<string>"
}
],
"databaseDependencies": {},
"databaseRetrievals": [
{
"condition": "<string>",
"fields": [
"<string>"
],
"joinedMeasure": [
"<string>"
],
"resultSizes": [
123
],
"retrievalId": 123,
"store": "<string>",
"timingInfo": {}
}
],
"dependencies": {},
"planInfo": "<unknown>",
"queryFilters": [
{
"description": "<string>",
"id": 123
}
],
"querySummary": {
"measures": [
"<string>"
],
"partialProviders": [
"<string>"
],
"partitioningCountByType": {},
"resultSizeByPartitioning": {},
"retrievalsCountByType": {},
"totalDatabaseResultSize": 123,
"totalRetrievals": 123
}
}
]Retrieve query execution plan by ID
Retrieves the execution plan for a specific query by its unique identifier.
This endpoint re-executes the stored MDX query to generate the query plan data. The query must be of type MDX, otherwise a BadArgumentException will be thrown. An optional timeout can be specified to limit the execution time of the query plan generation.
Note: This operation requires an active cube setup and will re-execute the query.
Since revision 2, a new measuresData field is available in the response.
The measures field is deprecated in favor of measuresData.
GET
/
activeviam
/
query-history
/
rest
/
v1
/
query
/
{id}
/
query-plan
Retrieve query execution plan by ID
curl --request GET \
--url https://{host}/activeviam/query-history/rest/v1/query/{id}/query-planimport requests
url = "https://{host}/activeviam/query-history/rest/v1/query/{id}/query-plan"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://{host}/activeviam/query-history/rest/v1/query/{id}/query-plan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/activeviam/query-history/rest/v1/query/{id}/query-plan",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{host}/activeviam/query-history/rest/v1/query/{id}/query-plan"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{host}/activeviam/query-history/rest/v1/query/{id}/query-plan")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/activeviam/query-history/rest/v1/query/{id}/query-plan")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body[
{
"aggregateRetrievals": [
{
"filterId": 123,
"horizontalDispatching": {
"dispatchingPerApplication": [
{
"applicationName": "<string>",
"dispatchingPerLevel": {}
}
]
},
"location": [
{
"dimension": "<string>",
"hierarchy": "<string>",
"level": [
"<string>"
],
"path": [
"<unknown>"
]
}
],
"measureProvider": "<string>",
"measures": [
"<string>"
],
"measuresData": [
{
"name": "<string>"
}
],
"partialProviderName": "<string>",
"partitioning": "<string>",
"resultSizes": [
123
],
"retrievalId": 123,
"timingInfo": {},
"type": "<string>",
"underlyingDataNodes": [
"<string>"
],
"underlyingRetrievalType": "<string>"
}
],
"databaseDependencies": {},
"databaseRetrievals": [
{
"condition": "<string>",
"fields": [
"<string>"
],
"joinedMeasure": [
"<string>"
],
"resultSizes": [
123
],
"retrievalId": 123,
"store": "<string>",
"timingInfo": {}
}
],
"dependencies": {},
"planInfo": "<unknown>",
"queryFilters": [
{
"description": "<string>",
"id": 123
}
],
"querySummary": {
"measures": [
"<string>"
],
"partialProviders": [
"<string>"
],
"partitioningCountByType": {},
"resultSizeByPartitioning": {},
"retrievalsCountByType": {},
"totalDatabaseResultSize": 123,
"totalRetrievals": 123
}
}
][
{
"aggregateRetrievals": [
{
"filterId": 123,
"horizontalDispatching": {
"dispatchingPerApplication": [
{
"applicationName": "<string>",
"dispatchingPerLevel": {}
}
]
},
"location": [
{
"dimension": "<string>",
"hierarchy": "<string>",
"level": [
"<string>"
],
"path": [
"<unknown>"
]
}
],
"measureProvider": "<string>",
"measures": [
"<string>"
],
"measuresData": [
{
"name": "<string>"
}
],
"partialProviderName": "<string>",
"partitioning": "<string>",
"resultSizes": [
123
],
"retrievalId": 123,
"timingInfo": {},
"type": "<string>",
"underlyingDataNodes": [
"<string>"
],
"underlyingRetrievalType": "<string>"
}
],
"databaseDependencies": {},
"databaseRetrievals": [
{
"condition": "<string>",
"fields": [
"<string>"
],
"joinedMeasure": [
"<string>"
],
"resultSizes": [
123
],
"retrievalId": 123,
"store": "<string>",
"timingInfo": {}
}
],
"dependencies": {},
"planInfo": "<unknown>",
"queryFilters": [
{
"description": "<string>",
"id": 123
}
],
"querySummary": {
"measures": [
"<string>"
],
"partialProviders": [
"<string>"
],
"partitioningCountByType": {},
"resultSizeByPartitioning": {},
"retrievalsCountByType": {},
"totalDatabaseResultSize": 123,
"totalRetrievals": 123
}
}
][
{
"aggregateRetrievals": [
{
"filterId": 123,
"horizontalDispatching": {
"dispatchingPerApplication": [
{
"applicationName": "<string>",
"dispatchingPerLevel": {}
}
]
},
"location": [
{
"dimension": "<string>",
"hierarchy": "<string>",
"level": [
"<string>"
],
"path": [
"<unknown>"
]
}
],
"measureProvider": "<string>",
"measures": [
"<string>"
],
"measuresData": [
{
"name": "<string>"
}
],
"partialProviderName": "<string>",
"partitioning": "<string>",
"resultSizes": [
123
],
"retrievalId": 123,
"timingInfo": {},
"type": "<string>",
"underlyingDataNodes": [
"<string>"
],
"underlyingRetrievalType": "<string>"
}
],
"databaseDependencies": {},
"databaseRetrievals": [
{
"condition": "<string>",
"fields": [
"<string>"
],
"joinedMeasure": [
"<string>"
],
"resultSizes": [
123
],
"retrievalId": 123,
"store": "<string>",
"timingInfo": {}
}
],
"dependencies": {},
"planInfo": "<unknown>",
"queryFilters": [
{
"description": "<string>",
"id": 123
}
],
"querySummary": {
"measures": [
"<string>"
],
"partialProviders": [
"<string>"
],
"partitioningCountByType": {},
"resultSizeByPartitioning": {},
"retrievalsCountByType": {},
"totalDatabaseResultSize": 123,
"totalRetrievals": 123
}
}
][
{
"aggregateRetrievals": [
{
"filterId": 123,
"horizontalDispatching": {
"dispatchingPerApplication": [
{
"applicationName": "<string>",
"dispatchingPerLevel": {}
}
]
},
"location": [
{
"dimension": "<string>",
"hierarchy": "<string>",
"level": [
"<string>"
],
"path": [
"<unknown>"
]
}
],
"measureProvider": "<string>",
"measures": [
"<string>"
],
"measuresData": [
{
"name": "<string>"
}
],
"partialProviderName": "<string>",
"partitioning": "<string>",
"resultSizes": [
123
],
"retrievalId": 123,
"timingInfo": {},
"type": "<string>",
"underlyingDataNodes": [
"<string>"
],
"underlyingRetrievalType": "<string>"
}
],
"databaseDependencies": {},
"databaseRetrievals": [
{
"condition": "<string>",
"fields": [
"<string>"
],
"joinedMeasure": [
"<string>"
],
"resultSizes": [
123
],
"retrievalId": 123,
"store": "<string>",
"timingInfo": {}
}
],
"dependencies": {},
"planInfo": "<unknown>",
"queryFilters": [
{
"description": "<string>",
"id": 123
}
],
"querySummary": {
"measures": [
"<string>"
],
"partialProviders": [
"<string>"
],
"partitioningCountByType": {},
"resultSizeByPartitioning": {},
"retrievalsCountByType": {},
"totalDatabaseResultSize": 123,
"totalRetrievals": 123
}
}
]Path Parameters
Unique identifier of the query history entry: its query id, as 16 lowercase hexadecimal characters, or as a decimal number when atoti.server.query-history.legacy-id-format is true
Query Parameters
Optional timeout for query plan generation in ISO-8601 duration format (e.g., PT30S for 30 seconds)
Response
Query execution plan retrieved successfully
Was this page helpful?