Skip to main content
GET
/
v1
/
meta
Load Metadata
curl --request GET \
  --url https://{deployment}.{region}.cubecloudapp.dev/cubejs-api/v1/meta \
  --header 'Authorization: <api-key>'
{
  "cubes": [
    {
      "name": "<string>",
      "measures": [
        {
          "name": "<string>",
          "type": "<string>",
          "title": "<string>",
          "shortTitle": "<string>",
          "description": "<string>",
          "aggType": "<string>",
          "meta": {},
          "formatDescription": {
            "name": "<string>",
            "specifier": "<string>",
            "currency": "<string>"
          },
          "currency": "<string>",
          "aliasMember": "<string>"
        }
      ],
      "dimensions": [
        {
          "name": "<string>",
          "type": "<string>",
          "title": "<string>",
          "shortTitle": "<string>",
          "description": "<string>",
          "aliasMember": "<string>",
          "granularities": [
            {
              "name": "<string>",
              "title": "<string>",
              "interval": "<string>",
              "sql": "<string>",
              "offset": "<string>",
              "origin": "<string>"
            }
          ],
          "meta": {},
          "formatDescription": {
            "name": "<string>",
            "specifier": "<string>",
            "currency": "<string>"
          },
          "currency": "<string>",
          "key": "<string>"
        }
      ],
      "segments": [
        {
          "name": "<string>",
          "title": "<string>",
          "shortTitle": "<string>",
          "description": "<string>",
          "meta": {}
        }
      ],
      "title": "<string>",
      "meta": {},
      "description": "<string>",
      "joins": [
        {
          "name": "<string>",
          "relationship": "<string>"
        }
      ],
      "folders": [
        {
          "name": "<string>",
          "members": [
            "<string>"
          ]
        }
      ],
      "nestedFolders": [
        {
          "name": "<string>",
          "members": [
            "<string>"
          ]
        }
      ],
      "hierarchies": [
        {
          "name": "<string>",
          "levels": [
            "<string>"
          ],
          "aliasMember": "<string>",
          "title": "<string>"
        }
      ]
    }
  ],
  "compilerId": "<string>"
}

Authorizations

Authorization
string
header
required

Cube API token (a JWT). Sent directly in the Authorization header, e.g. Authorization: <CUBE_API_TOKEN> (no "Bearer" prefix).

Response

successful operation

cubes
object[]
compilerId
string