Skip to main content

Cubes Endpoints

Endpoints for listing and managing cubes within a project.

List Cubes

Retrieve all cubes in a project.
GET /api/v1/{project}/cubes
X-Api-Key
string
required
Your API key

Response

{
  "data": [
    {
      "slug": "blog-posts",
      "name": "Blog Posts",
      "columns": [],
      "record_count": 42
    }
  ]
}

Get Cube Schema

Retrieve the schema (columns and settings) for a specific cube.
GET /api/v1/{project}/cubes/{cube_slug}

Response

{
  "slug": "blog-posts",
  "name": "Blog Posts",
  "columns": [
    {
      "name": "title",
      "type": "text",
      "required": true,
      "public": true
    },
    {
      "name": "content",
      "type": "richtext",
      "required": false,
      "public": true
    }
  ]
}