> ## 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.

# 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.

> Executes the given MDX SELECT query and returns only the query plan. Each query plan includes its underlying MDX pass. Pass naming convention: all passes except Sub-Select are named SelectPass_PassId.



## OpenAPI

````yaml get /activeviam/pivot/rest/v10/cube/query/mdx/queryplan
openapi: 3.0.0
info:
  title: Atoti REST services
  version: 6.1.18-SNAPSHOT
servers:
  - description: Generated server url
    url: http://localhost:9090
security: []
tags:
  - description: Implementation of the REST API controller for an ActivePivot database.
    name: Database REST API
  - description: >
      XML for Analysis (XMLA) endpoint for executing MDX queries and OLAP
      discovery operations.


      This endpoint implements the XMLA protocol which is used by:

      - Microsoft Excel and other OLAP clients

      - Custom BI tools that support XMLA connectivity


      The endpoint supports both text XML and binary XML formats for improved
      performance.
    name: XMLA API
  - description: Definition of REST API to query data from ActivePivot (V10).
    name: Query REST API (V10)
  - description: Definition of REST API to query data from ActivePivot (V9).
    name: Query REST API (V9)
  - description: Implementation of the REST Bulk API of the content server (version 8).
    name: Bulk REST API
  - description: Implementation of the REST API of the content server.
    name: Content Server REST API
  - description: Implementation of the REST API controller for an ActivePivot database.
    name: Database REST API v9
  - description: ' Definition of the REST service returning the list of services exposed by an application.'
    name: Version REST API
  - description: Rest Service providing the discovery information.
    name: Discovery REST API
  - description: API to access measures information.
    name: Diagnostics API
  - description: JSON Web Token (JWT) endpoint.
    name: JWT API
  - description: >
      Endpoints to retrieve and manage query history.


      **Note:** This API is experimental and may change in future versions
      without notice.
    name: Query History REST API (Experimental)
  - description: Description of REST API to configure an ActivePivot application.
    name: Configuration REST API
  - description: API to export the result of MDX queries
    name: Data Export
  - description: >
      GetAggregatesQuery (GAQ) REST API for executing OLAP queries.


      This API provides a programmatic way to execute GetAggregatesQuery
      operations

      against Atoti cubes. Results and updates are streamed in Apache Arrow
      format for efficient

      data transfer and processing.
    name: Continuous GAQ Query REST API (Experimental)
  - description: Endpoints for AI-based optimization of Atoti cubes
    name: AI Optimizer
  - description: >
      GetAggregatesQuery (GAQ) REST API for executing OLAP queries.


      This API provides a programmatic way to execute GetAggregatesQuery
      operations

      against Atoti cubes. Results are returned in Apache Arrow format for
      efficient

      data transfer and processing.


      **Note:** This API is experimental and may change in future versions
      without notice.
    name: GAQ Query REST API (Experimental)
  - description: Implementation of the REST Bulk API of the content server.
    name: Bulk REST API
paths:
  /activeviam/pivot/rest/v10/cube/query/mdx/queryplan:
    get:
      tags:
        - Query REST API (V10)
      summary: >-
        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.
      description: >-
        Executes the given MDX SELECT query and returns only the query plan.
        Each query plan includes its underlying MDX pass. Pass naming
        convention: all passes except Sub-Select are named SelectPass_PassId.
      operationId: mdxQueryPlanGet_1
      parameters:
        - description: The query to run
          in: query
          name: mdx
          required: true
          schema:
            type: string
        - description: The query timeout limit in seconds.
          in: query
          name: timeout
          required: false
          schema:
            format: int32
            type: integer
        - description: Whether ask for a summary or full query plan export.
          in: query
          name: asSummary
          required: false
          schema:
            default: 'false'
            type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/JsonQueryPlanData'
          description: The query plans resulting from the MDX SELECT query.
        '400':
          content:
            '*/*':
              schema:
                items:
                  $ref: '#/components/schemas/JsonQueryPlanData'
                type: array
          description: When there is an error with the given MDX query
        '401':
          content:
            '*/*':
              schema:
                items:
                  $ref: '#/components/schemas/JsonQueryPlanData'
                type: array
          description: Resource only available to connected user
components:
  schemas:
    JsonQueryPlanData:
      properties:
        aggregateRetrievals:
          items:
            $ref: '#/components/schemas/RetrievalData'
          type: array
        databaseDependencies:
          additionalProperties:
            items:
              format: int32
              type: integer
            type: array
            uniqueItems: true
          type: object
        databaseRetrievals:
          items:
            $ref: '#/components/schemas/DatabaseRetrievalData'
          type: array
        dependencies:
          additionalProperties:
            items:
              format: int32
              type: integer
            type: array
            uniqueItems: true
          type: object
        planInfo:
          $ref: '#/components/schemas/IPlanInfoData'
        queryFilters:
          items:
            $ref: '#/components/schemas/FilterData'
          type: array
        querySummary:
          $ref: '#/components/schemas/QuerySummaryData'
      type: object
    RetrievalData:
      properties:
        filterId:
          format: int32
          type: integer
        horizontalDispatching:
          $ref: '#/components/schemas/QueryDispatchingData'
        location:
          items:
            $ref: '#/components/schemas/LocationData'
          type: array
        measureProvider:
          type: string
        measures:
          items:
            type: string
          type: array
        partialProviderName:
          type: string
        partitioning:
          type: string
        resultSizes:
          items:
            format: int32
            type: integer
          type: array
        retrievalId:
          format: int32
          type: integer
        timingInfo:
          additionalProperties:
            items:
              format: int64
              type: integer
            type: array
          type: object
        type:
          type: string
        underlyingDataNodes:
          items:
            type: string
          type: array
      type: object
    DatabaseRetrievalData:
      properties:
        condition:
          type: string
        fields:
          items:
            type: string
          type: array
          uniqueItems: true
        joinedMeasure:
          items:
            type: string
          type: array
          uniqueItems: true
        resultSizes:
          items:
            format: int32
            type: integer
          type: array
        retrievalId:
          format: int32
          type: integer
        store:
          type: string
        timingInfo:
          additionalProperties:
            items:
              format: int64
              type: integer
            type: array
          type: object
      type: object
    IPlanInfoData:
      type: object
    FilterData:
      properties:
        description:
          type: string
        id:
          format: int32
          type: integer
      type: object
    QuerySummaryData:
      properties:
        measures:
          items:
            type: string
          type: array
          uniqueItems: true
        partialProviders:
          items:
            type: string
          type: array
          uniqueItems: true
        partitioningCountByType:
          additionalProperties:
            format: int32
            type: integer
          type: object
        resultSizeByPartitioning:
          additionalProperties:
            format: int32
            type: integer
          type: object
        retrievalsCountByType:
          additionalProperties:
            format: int32
            type: integer
          type: object
        totalDatabaseResultSize:
          format: int32
          type: integer
        totalRetrievals:
          format: int32
          type: integer
      type: object
    QueryDispatchingData:
      properties:
        dispatchingPerApplication:
          items:
            $ref: '#/components/schemas/ApplicationDispatchingData'
          type: array
      type: object
    LocationData:
      properties:
        dimension:
          type: string
        hierarchy:
          type: string
        level:
          items:
            type: string
          type: array
        path:
          items:
            type: object
          type: array
      type: object
    ApplicationDispatchingData:
      properties:
        applicationName:
          type: string
        dispatchingPerLevel:
          additionalProperties:
            additionalProperties:
              $ref: '#/components/schemas/CubeDispatchingData'
            type: object
          type: object
      type: object
    CubeDispatchingData:
      properties:
        dispatchedMembers:
          additionalProperties:
            items:
              type: object
            type: array
          type: object
      type: object

````