> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cube.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Load Metadata



## OpenAPI

````yaml /api-reference/core-data.yaml get /v1/meta
openapi: 3.0.0
info:
  title: Cube Core Data REST (JSON) API
  version: 1.0.0
  description: |-
    Deliver data from Cube over HTTP. Run queries with `POST /v1/load` and
    retrieve the data model with `GET /v1/meta`. The `{base_path}` segment
    (`/cubejs-api` by default) is configurable.
servers:
  - url: https://{deployment}.{region}.cubecloudapp.dev/cubejs-api
    description: >-
      Cube Cloud deployment REST API. The host includes your deployment slug and
      region; copy the exact URL from your deployment's API settings. The
      /cubejs-api base path is configurable.
    variables:
      deployment:
        default: your-deployment
        description: Your Cube Cloud deployment slug
      region:
        default: aws-us-east-1
        description: >-
          Cloud region of your deployment, e.g. aws-us-east-1, aws-eu-central-1,
          gcp-us-central1
  - url: http://localhost:4000/cubejs-api
    description: Self-hosted Cube (default port and base path).
security:
  - apiToken: []
tags:
  - name: Data
paths:
  /v1/meta:
    get:
      tags:
        - Data
      summary: Load Metadata
      operationId: metaV1
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1MetaResponse'
        4XX:
          description: Request could not be completed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1Error'
        5XX:
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1Error'
      security:
        - apiToken: []
components:
  schemas:
    V1MetaResponse:
      type: object
      properties:
        cubes:
          type: array
          items:
            $ref: '#/components/schemas/V1CubeMeta'
        compilerId:
          type: string
    V1Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
    V1CubeMeta:
      type: object
      required:
        - name
        - type
        - measures
        - dimensions
        - segments
      properties:
        name:
          type: string
        title:
          type: string
        type:
          $ref: '#/components/schemas/V1CubeMetaType'
        meta:
          type: object
        description:
          type: string
        measures:
          type: array
          items:
            $ref: '#/components/schemas/V1CubeMetaMeasure'
        dimensions:
          type: array
          items:
            $ref: '#/components/schemas/V1CubeMetaDimension'
        segments:
          type: array
          items:
            $ref: '#/components/schemas/V1CubeMetaSegment'
        joins:
          type: array
          items:
            $ref: '#/components/schemas/V1CubeMetaJoin'
        folders:
          type: array
          items:
            $ref: '#/components/schemas/V1CubeMetaFolder'
        nestedFolders:
          type: array
          items:
            $ref: '#/components/schemas/V1CubeMetaNestedFolder'
        hierarchies:
          type: array
          items:
            $ref: '#/components/schemas/V1CubeMetaHierarchy'
    V1CubeMetaType:
      type: string
      description: Type of cube
      enum:
        - cube
        - view
    V1CubeMetaMeasure:
      type: object
      required:
        - name
        - type
      properties:
        name:
          type: string
        title:
          type: string
        shortTitle:
          type: string
        description:
          type: string
        type:
          type: string
        aggType:
          type: string
        meta:
          type: object
        format:
          $ref: '#/components/schemas/V1CubeMetaFormat'
        formatDescription:
          $ref: '#/components/schemas/V1CubeMetaFormatDescription'
        currency:
          type: string
          description: ISO 4217 currency code in uppercase (3 characters, e.g. USD, EUR)
        aliasMember:
          description: >-
            When measure is defined in View, it keeps the original path:
            Cube.measure
          type: string
    V1CubeMetaDimension:
      type: object
      required:
        - name
        - type
      properties:
        name:
          type: string
        title:
          type: string
        shortTitle:
          type: string
        description:
          type: string
        type:
          type: string
        aliasMember:
          description: >-
            When dimension is defined in View, it keeps the original path:
            Cube.dimension
          type: string
        granularities:
          type: array
          items:
            $ref: '#/components/schemas/V1CubeMetaDimensionGranularity'
        meta:
          type: object
        format:
          $ref: '#/components/schemas/V1CubeMetaFormat'
        formatDescription:
          $ref: '#/components/schemas/V1CubeMetaFormatDescription'
        currency:
          type: string
          description: ISO 4217 currency code in uppercase (3 characters, e.g. USD, EUR)
        order:
          $ref: '#/components/schemas/V1CubeMetaDimensionOrder'
        key:
          type: string
          description: Key reference for the dimension
    V1CubeMetaSegment:
      type: object
      required:
        - name
        - title
        - shortTitle
      properties:
        name:
          type: string
        title:
          type: string
        description:
          type: string
        shortTitle:
          type: string
        meta:
          type: object
    V1CubeMetaJoin:
      type: object
      required:
        - name
        - relationship
      properties:
        name:
          type: string
        relationship:
          type: string
    V1CubeMetaFolder:
      type: object
      required:
        - name
        - members
      properties:
        name:
          type: string
        members:
          type: array
          items:
            type: string
    V1CubeMetaNestedFolder:
      type: object
      required:
        - name
        - members
      properties:
        name:
          type: string
        members:
          type: array
          items:
            type: string
            oneOf:
              - type: string
              - $ref: '#/components/schemas/V1CubeMetaNestedFolder'
    V1CubeMetaHierarchy:
      type: object
      required:
        - name
        - levels
      properties:
        name:
          type: string
        aliasMember:
          description: >-
            When hierarchy is defined in Cube, it keeps the original path:
            Cube.hierarchy
          type: string
        title:
          type: string
        levels:
          type: array
          items:
            type: string
    V1CubeMetaFormat:
      oneOf:
        - $ref: '#/components/schemas/V1CubeMetaSimpleFormat'
        - $ref: '#/components/schemas/V1CubeMetaLinkFormat'
        - $ref: '#/components/schemas/V1CubeMetaCustomTimeFormat'
        - $ref: '#/components/schemas/V1CubeMetaCustomNumericFormat'
      description: >-
        Format of measure or dimension - can be a simple string format, a link
        configuration, a custom time format, or a custom numeric format
    V1CubeMetaFormatDescription:
      type: object
      description: >-
        Resolved format description with the predefined name and d3-format
        specifier
      required:
        - name
        - specifier
      properties:
        name:
          type: string
          description: >-
            Predefined format name (e.g., 'percent_2', 'currency_1') or a base
            name like 'number', or 'custom' for ad-hoc specifiers
        specifier:
          type: string
          description: >-
            d3-format specifier string (e.g., '.2f', ',.0f', '$,.2f'). See
            https://d3js.org/d3-format
        currency:
          type: string
          description: >-
            ISO 4217 currency code in uppercase (e.g. USD, EUR). Present when a
            currency format is used.
    V1CubeMetaDimensionGranularity:
      type: object
      required:
        - name
        - title
      properties:
        name:
          type: string
        title:
          type: string
        interval:
          type: string
        sql:
          type: string
        offset:
          type: string
        origin:
          type: string
    V1CubeMetaDimensionOrder:
      type: string
      enum:
        - asc
        - desc
    V1CubeMetaSimpleFormat:
      type: string
      description: Simple format
      enum:
        - percent
        - currency
        - number
        - imageUrl
        - id
        - link
    V1CubeMetaLinkFormat:
      type: object
      description: Link format with label and type
      properties:
        label:
          type: string
          description: Label for the link
        type:
          type: string
          enum:
            - link
          description: Type of the format (must be 'link')
      required:
        - label
        - type
    V1CubeMetaCustomTimeFormat:
      type: object
      description: Custom time format for time dimensions
      properties:
        type:
          type: string
          enum:
            - custom-time
          description: Type of the format (must be 'custom-time')
        value:
          type: string
          description: >-
            POSIX strftime format string (IEEE Std 1003.1 / POSIX.1) with
            d3-time-format extensions (e.g., '%Y-%m-%d', '%d/%m/%Y %H:%M:%S').
            See
            https://pubs.opengroup.org/onlinepubs/009695399/functions/strptime.html
            and https://d3js.org/d3-time-format
      required:
        - type
        - value
    V1CubeMetaCustomNumericFormat:
      type: object
      description: Custom numeric format for numeric measures and dimensions
      properties:
        type:
          type: string
          enum:
            - custom-numeric
          description: Type of the format (must be 'custom-numeric')
        value:
          type: string
          description: >-
            d3-format specifier string (e.g., '.2f', ',.0f', '$,.2f', '.0%',
            '.2s'). See https://d3js.org/d3-format
        alias:
          type: string
          description: >-
            Name of the predefined format (e.g., 'percent_2', 'currency_1').
            Present only when a named format was used.
      required:
        - type
        - value
  securitySchemes:
    apiToken:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Cube API token (a JWT). Sent directly in the Authorization header, e.g.
        `Authorization: <CUBE_API_TOKEN>` (no "Bearer" prefix).

````