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

# Get discovery information

> Retrieves the JSON representation of the cube discovery information.

**Availability:** Since **revision 5** of the Pivot API, each level includes a `dataType` object describing the type of the data stored by the level.



## OpenAPI

````yaml engine/rest/6.2.2/openapi.json GET /activeviam/pivot/rest/v9/cube/discovery
openapi: 3.1.0
info:
  title: Atoti REST services
  version: 6.2.2-SNAPSHOT
servers:
  - description: The Atoti Server instance to query, over HTTPS
    url: https://{host}
    variables:
      host:
        default: my-atoti-server:9090
        description: Host and port of your Atoti Server instance
  - description: The Atoti Server instance to query, over plain HTTP
    url: http://{host}
    variables:
      host:
        default: my-atoti-server:9090
        description: Host and port of your Atoti Server instance
security: []
tags:
  - description: Implementation of the REST API controller for an ActivePivot database.
    name: Database REST API
  - 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
  - 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: >-
      Endpoints for Atoti Auto-Explain, which explains how a measure varies
      between two members by attributing the variation to the hierarchies that
      drive it.
    name: Auto-Explain
  - 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
  - description: Endpoints of the Atoti BI adapter.
    name: BI Adapter REST API
  - description: Endpoints for AI-based optimization of Atoti cubes
    name: AI Optimizer
  - description: Implementation of the REST Bulk API of the content server.
    name: Bulk REST API
paths:
  /activeviam/pivot/rest/v9/cube/discovery:
    get:
      tags:
        - Discovery REST API
      summary: Get discovery information
      description: >-
        Retrieves the JSON representation of the cube discovery information.


        **Availability:** Since **revision 5** of the Pivot API, each level
        includes a `dataType` object describing the type of the data stored by
        the level.
      operationId: query
      parameters:
        - in: header
          name: arg0
          required: true
          schema:
            $ref: '#/components/schemas/HttpHeaders'
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/JsonDiscovery'
          description: The ActivePivot's catalogs and their content.
        '401':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/JsonDiscovery'
          description: Resource only available to connected user
components:
  schemas:
    HttpHeaders:
      properties:
        accept:
          items:
            $ref: '#/components/schemas/MediaType'
          type: array
        acceptCharset:
          items:
            type: string
          type: array
        acceptLanguage:
          items:
            properties:
              range:
                type: string
              weight:
                format: double
                type: number
            type: object
          type: array
        acceptLanguageAsLocales:
          items:
            type: string
          type: array
        acceptPatch:
          items:
            $ref: '#/components/schemas/MediaType'
          type: array
        accessControlAllowCredentials:
          type: boolean
        accessControlAllowHeaders:
          items:
            type: string
          type: array
        accessControlAllowMethods:
          items:
            $ref: '#/components/schemas/HttpMethod'
          type: array
        accessControlAllowOrigin:
          type: string
        accessControlExposeHeaders:
          items:
            type: string
          type: array
        accessControlMaxAge:
          format: int64
          type: integer
        accessControlRequestHeaders:
          items:
            type: string
          type: array
        accessControlRequestMethod:
          $ref: '#/components/schemas/HttpMethod'
        all:
          additionalProperties:
            type: string
          type: object
          writeOnly: true
        allow:
          items:
            $ref: '#/components/schemas/HttpMethod'
          type: array
          uniqueItems: true
        basicAuth:
          type: string
          writeOnly: true
        bearerAuth:
          type: string
          writeOnly: true
        cacheControl:
          type: string
        connection:
          items:
            type: string
          type: array
        contentDisposition:
          $ref: '#/components/schemas/ContentDisposition'
        contentLanguage:
          type: string
        contentLength:
          format: int64
          type: integer
        contentType:
          $ref: '#/components/schemas/MediaType'
        date:
          format: int64
          type: integer
        empty:
          type: boolean
        etag:
          type: string
        expires:
          format: int64
          type: integer
        host:
          properties:
            address:
              properties:
                address:
                  format: byte
                  type: string
                anyLocalAddress:
                  type: boolean
                canonicalHostName:
                  type: string
                hostAddress:
                  type: string
                hostName:
                  type: string
                linkLocalAddress:
                  type: boolean
                loopbackAddress:
                  type: boolean
                mcglobal:
                  type: boolean
                mclinkLocal:
                  type: boolean
                mcnodeLocal:
                  type: boolean
                mcorgLocal:
                  type: boolean
                mcsiteLocal:
                  type: boolean
                multicastAddress:
                  type: boolean
                siteLocalAddress:
                  type: boolean
              type: object
            hostName:
              type: string
            hostString:
              type: string
            port:
              format: int32
              type: integer
            unresolved:
              type: boolean
          type: object
        ifMatch:
          items:
            type: string
          type: array
        ifModifiedSince:
          format: int64
          type: integer
        ifNoneMatch:
          items:
            type: string
          type: array
        ifUnmodifiedSince:
          format: int64
          type: integer
        lastModified:
          format: int64
          type: integer
        location:
          format: uri
          type: string
        origin:
          type: string
        pragma:
          type: string
        range:
          items:
            $ref: '#/components/schemas/HttpRange'
          type: array
        upgrade:
          type: string
        vary:
          items:
            type: string
          type: array
      type: object
    JsonDiscovery:
      properties:
        catalogs:
          items:
            $ref: '#/components/schemas/CatalogDiscovery'
          type: array
        contextValues:
          items:
            $ref: '#/components/schemas/ContextValueDiscovery'
          type: array
      type: object
    MediaType:
      properties:
        charset:
          type: string
        concrete:
          type: boolean
        parameters:
          additionalProperties:
            type: string
          type: object
        qualityValue:
          format: double
          type: number
        subtype:
          type: string
        subtypeSuffix:
          type: string
        type:
          type: string
        wildcardSubtype:
          type: boolean
        wildcardType:
          type: boolean
      type: object
    HttpMethod: {}
    ContentDisposition:
      properties:
        attachment:
          type: boolean
        charset:
          type: string
        filename:
          type: string
        formData:
          type: boolean
        inline:
          type: boolean
        name:
          type: string
        type:
          type: string
      type: object
    HttpRange: {}
    CatalogDiscovery:
      properties:
        cubes:
          items:
            $ref: '#/components/schemas/CubeDiscovery'
          type: array
        name:
          type: string
      type: object
    ContextValueDiscovery:
      properties:
        category:
          type: string
        description:
          type: string
        name:
          type: string
        type:
          type: string
      type: object
    CubeDiscovery:
      properties:
        caption:
          type: string
        contextValues:
          items:
            $ref: '#/components/schemas/JsonContextValue'
          type: array
        defaultMembers:
          items:
            $ref: '#/components/schemas/DefaultMemberDiscovery'
          type: array
        dimensions:
          items:
            $ref: '#/components/schemas/DimensionDiscovery'
          type: array
        kpis:
          items:
            $ref: '#/components/schemas/KpiDiscovery'
          type: array
        measureGroups:
          items:
            $ref: '#/components/schemas/MeasureGroupDiscovery'
          type: array
        measures:
          items:
            $ref: '#/components/schemas/MeasureDiscovery'
          type: array
        name:
          type: string
        sets:
          items:
            $ref: '#/components/schemas/SetDiscovery'
          type: array
      type: object
    JsonContextValue:
      properties:
        name:
          type: string
        value:
          type: string
      type: object
    DefaultMemberDiscovery:
      properties:
        caption:
          items:
            type: string
          type: array
          writeOnly: true
        captionPath:
          items:
            type: string
          type: array
        dimension:
          type: string
        hierarchy:
          type: string
        path:
          items:
            type: string
          type: array
      type: object
    DimensionDiscovery:
      properties:
        caption:
          type: string
        defaultHierarchy:
          type: string
        description:
          type: string
        hierarchies:
          items:
            $ref: '#/components/schemas/HierarchyDiscovery'
          type: array
        measureGroups:
          items:
            type: string
          type: array
          uniqueItems: true
        name:
          type: string
        type:
          type: string
        visible:
          type: boolean
      type: object
    KpiDiscovery:
      properties:
        caption:
          type: string
        description:
          type: string
        expiry:
          type: string
        folder:
          type: string
        goal:
          type: string
        measureGroup:
          type: string
        name:
          type: string
        parent:
          type: string
        start:
          type: string
        status:
          type: string
        statusPresenter:
          type: string
        trend:
          type: string
        trendPresenter:
          type: string
        value:
          type: string
        weight:
          type: string
      type: object
    MeasureGroupDiscovery:
      properties:
        caption:
          type: string
        description:
          type: string
        name:
          type: string
      type: object
    MeasureDiscovery:
      properties:
        caption:
          type: string
        description:
          type: string
        expression:
          type: string
        folder:
          type: string
        formatString:
          type: string
        measureGroup:
          type: string
        name:
          type: string
        type:
          type: string
        visible:
          type: boolean
      type: object
    SetDiscovery:
      properties:
        caption:
          type: string
        description:
          type: string
        expression:
          type: string
        folder:
          type: string
        name:
          type: string
      type: object
    HierarchyDiscovery:
      properties:
        caption:
          type: string
        description:
          type: string
        folder:
          type: string
        levels:
          items:
            $ref: '#/components/schemas/LevelDiscovery'
          type: array
        name:
          type: string
        slicing:
          type: boolean
        virtual:
          type: boolean
        visible:
          type: boolean
      type: object
    LevelDiscovery:
      properties:
        caption:
          type: string
        dataType:
          $ref: '#/components/schemas/LevelDataTypeDiscovery'
        description:
          type: string
        name:
          type: string
        type:
          type: string
      type: object
    LevelDataTypeDiscovery:
      properties:
        contentType:
          enum:
            - BOOLEAN
            - BOOLEAN_ARRAY
            - DOUBLE
            - DOUBLE_ARRAY
            - FLOAT
            - FLOAT_ARRAY
            - INTEGER
            - INTEGER_ARRAY
            - LONG
            - LONG_ARRAY
            - OBJECT
            - OBJECT_ARRAY
            - STRING
            - STRING_ARRAY
          type: string
        dataClass:
          type: string
        nullable:
          type: boolean
      type: object

````