Skip to main content

Meta Information

Deprecated

The Cube API is deprecated, and the REST API should be used instead.

Meta-information for the cubes defined in the data model can be retrieved.

Request​

🚀 GET

BASE_URL/cube/v1/meta

Request

Headers

  • Authorization Token returned by authentication process

Responses

200 Successful
{
  "cubes": [
      "public": true,
      "name": "Groups",
      "title": "Groups",
      "dimensions": [
          {
              "name": "Groups.id",
              "title": "Groups Id",
              "description": "The group's ID in Komodo Wellbeing",
              "type": "number",
              "shortTitle": "Id",
              "suggestFilterValues": true,
              "isVisible": true,
          },
          {
              "name": "Groups.name",
              "title": "Groups Name",
              "description": "The name of the group",
              "type": "string",
              "shortTitle": "Name",
              "suggestFilterValues": true,
              "isVisible": true,
          },
          ...
      ],
      "measures": [
          {
              "name": "Groups.count",
              "title": "Groups Count",
              "shortTitle": "Count",
              "type": "number",
              "aggType": "count",
              "isVisible": true,
          },
          ...
      ],
      "segments": [...],
      ...
  ]
}
401 Forbidden Missing or invalid authentication token
{
  "error": "Unauthorized",
}

Cube REST API