Skip to main content
GET
/
activeviam
/
pivot
/
rest
/
v10
/
cube
/
query
/
mdx
/
queryplan
Gets the query plans for an MDX SELECT query. Note that the given MDX is run and the result is computed but only the query plans are returned.
curl --request GET \
  --url http://localhost:9090/activeviam/pivot/rest/v10/cube/query/mdx/queryplan
{
  "aggregateRetrievals": [
    {
      "filterId": 123,
      "horizontalDispatching": {
        "dispatchingPerApplication": [
          {
            "applicationName": "<string>",
            "dispatchingPerLevel": {}
          }
        ]
      },
      "location": [
        {
          "dimension": "<string>",
          "hierarchy": "<string>",
          "level": [
            "<string>"
          ],
          "path": [
            {}
          ]
        }
      ],
      "measureProvider": "<string>",
      "measures": [
        "<string>"
      ],
      "partialProviderName": "<string>",
      "partitioning": "<string>",
      "resultSizes": [
        123
      ],
      "retrievalId": 123,
      "timingInfo": {},
      "type": "<string>",
      "underlyingDataNodes": [
        "<string>"
      ]
    }
  ],
  "databaseDependencies": {},
  "databaseRetrievals": [
    {
      "condition": "<string>",
      "fields": [
        "<string>"
      ],
      "joinedMeasure": [
        "<string>"
      ],
      "resultSizes": [
        123
      ],
      "retrievalId": 123,
      "store": "<string>",
      "timingInfo": {}
    }
  ],
  "dependencies": {},
  "planInfo": {},
  "queryFilters": [
    {
      "description": "<string>",
      "id": 123
    }
  ],
  "querySummary": {
    "measures": [
      "<string>"
    ],
    "partialProviders": [
      "<string>"
    ],
    "partitioningCountByType": {},
    "resultSizeByPartitioning": {},
    "retrievalsCountByType": {},
    "totalDatabaseResultSize": 123,
    "totalRetrievals": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.activeviam.com/llms.txt

Use this file to discover all available pages before exploring further.

Query Parameters

mdx
string
required

The query to run

timeout
integer<int32>

The query timeout limit in seconds.

asSummary
string
default:false

Whether ask for a summary or full query plan export.

Response

The query plans resulting from the MDX SELECT query.

aggregateRetrievals
object[]
databaseDependencies
object
databaseRetrievals
object[]
dependencies
object
planInfo
object
queryFilters
object[]
querySummary
object