REST (JSON) API reference

The {base_path} part of the endpoint URLs can be configured. By default, it’s /cubejs-api.

`{base_path}/v1/load`

Run the query to the REST (JSON) API and get the results.

Parameter	Description	Required
`query`	Either a single URL encoded Cube Query, or an array of queries	✅ Yes
`queryType`	If multiple queries are passed in `query` for data blending, this must be set to `multi`	❌ No
`cache`	See cache control. `stale-if-slow` by default	❌ No
`responseFormat`	Output format of the result `data` payload: `default` (row-oriented), `compact` (a `{ members, dataset }` object with rows of primitive arrays), or `columnar` (a `{ members, columns }` object with one primitive array per member). `default` by default	❌ No

Headers

Header	Description	Required
`Authorization`	API token for authentication	✅ Yes
`x-request-id`	Custom request identifier. When provided, this ID is used to track the query through the system and can be used to cancel the query. If not provided, a unique ID is generated automatically.	❌ No

Response

query - The query passed via params. It can be an array of queries and in such case it will be treated as a Data Blending query.
data - Formatted dataset of query results.
annotation - Metadata for query. Contains descriptions for all query items.
- title - Human readable title from the data model.
- shortTitle - Short title for visualization usage (ex. chart overlay)
- type - Data type
lastRefreshTime - An ISO 8601 timestamp indicating when the data was last refreshed.
external - A boolean indicating whether the query was served from a pre-aggregation in Cube Store. Present only when the query hit a pre-aggregation.
total - The total number of rows returned for the query. Useful for paginating results.

Example request:

# Request with http method GET
curl \
  -H "Authorization: TOKEN" \
  -G \
  --data-urlencode 'query={"measures":["users.count"]}' \
  http://localhost:4000/cubejs-api/v1/load

# Request with http method POST
# Use POST to fix problem with query length limits
curl \
 -X POST  \
 -H "Content-Type: application/json" \
 -H "Authorization: TOKEN" \
 --data '{"query": {"measures":["users.count"]}}' \
 http://localhost:4000/cubejs-api/v1/load

Example response:

{
  "query": {
    "measures": ["users.count"],
    "filters": [],
    "timezone": "UTC",
    "dimensions": [],
    "timeDimensions": []
  },
  "data": [
    {
      "users.count": "700"
    }
  ],
  "lastRefreshTime": "2025-01-13T12:00:00.000Z",
  "annotation": {
    "measures": {
      "users.count": {
        "title": "Users Count",
        "shortTitle": "Count",
        "type": "number"
      }
    },
    "dimensions": {},
    "segments": {},
    "timeDimensions": {}
  }
}

Currently all fetched numericals are returned in the same format as driver returns it without any additional processing. Most of drivers return numerical values as strings instead of javascript integer or float to ensure there’s no loss of significance. Client code should take care of parsing such numerical values.

`{base_path}/v1/sql`

Takes an API query and returns the SQL query that can be executed against the data source that is generated by Cube. This endpoint is useful for debugging, understanding how Cube translates API queries into SQL queries, and providing transparency to SQL-savvy end users. Using this endpoint to take the SQL query and execute it against the data source directly is not recommended as it bypasses Cube’s caching layer and other optimizations. Request parameters:

Parameter, type	Description	Required
`format`, `string`	Query format: `sql` for SQL API queries, `rest` for REST (JSON) API queries (default)	❌ No
`query`, `string`	Query as an URL-encoded JSON object or SQL query	✅ Yes
`disable_post_processing`, `boolean`	Flag that affects query planning, `true` or `false`	❌ No

If disable_post_processing is set to true, Cube will try to generate the SQL as if the query is run without post-processing, i.e., if it’s run as a query with pushdown. The response will contain a JSON object with the following properties under the sql key:

Property, type	Description
`status`, `string`	Query planning status, `ok` or `error`
`sql`, `array`	Two-element array (see below)
`sql[0]`, `string`	Generated query with parameter placeholders
`sql[1]`, `array` or `object`	Generated query parameters
`dataSource`, `string`	The name of the data source the generated query targets

For queries with the sql format, the response will also include the following additional properties under the sql key:

Property, type	Description
`query_type`, `string`	`regular` for regular queries, `post_processing` for queries with post-processing, `pushdown` for queries with pushdown

For queries with the sql format, in case of an error, the response will only contain status, query_type, and error properties. For example, an error will be returned if disable_post_processing was set to true but the query can’t be run without post-processing.

Example

Request with a query in the REST (JSON) API format:

curl \
  -H "Authorization: TOKEN" \
  -G \
  --data-urlencode 'query={"measures":["orders.count"]}' \
  --data-urlencode 'format=rest'  \
  http://localhost:4000/cubejs-api/v1/sql

Response:

{
  "sql": {
    "sql": [
      "SELECT sum(`base_orders__count`) `orders__count` FROM prod_pre_aggregations.base_orders_orders_by_month AS `base_orders__orders_by_month`  LIMIT 10000",
      []
    ]
  }
}

Request with a query in the SQL API format:

curl \
  -H "Authorization: TOKEN" \
  -G \
  --data-urlencode 'query=SELECT COUNT(*) FROM orders' \
  --data-urlencode 'format=sql'  \  
  http://localhost:4000/cubejs-api/v1/sql

Response:

{
  "sql": {
    "status": "ok",
    "sql": [
      "SELECT\n      count(\"base_orders\".id) \"count_uint8_1__\"\n    FROM\n      (SELECT * FROM 's3://cube-tutorial/orders.csv') AS \"base_orders\"  LIMIT 50000",
      []
    ],
    "query_type": "regular"
  }
}

Request with a query in the SQL API format that is executed with post-processing:

curl \
  -H "Authorization: TOKEN" \
  -G \
  --data-urlencode 'query=SELECT AVG(count) FROM (SELECT COUNT(*) AS count FROM orders) AS table' \
  --data-urlencode 'format=sql'  \ 
  http://localhost:4000/cubejs-api/v1/sql

Response:

{
  "sql": {
    "status": "error",
    "error": "Provided query can not be executed without post-processing.",
    "query_type": "post_processing"
  }
}

Request with a query in the SQL API format that is forced to be executed without post-processing, i.e., as a query with pushdown:

curl \
  -H "Authorization: TOKEN" \
  -G \
  --data-urlencode 'query=SELECT AVG(count) FROM (SELECT COUNT(*) AS count FROM orders) AS table' \
  --data-urlencode 'format=sql' \
  --data-urlencode 'disable_post_processing=true'  \
  http://localhost:4000/cubejs-api/v1/sql

Response:

{
  "sql": {
    "status": "ok",
    "sql": [
      "SELECT \"table\".\"avg_table_count_\" \"avg_table_count_\" \nFROM (\n  SELECT AVG(\"table\".\"count\") \"avg_table_count_\" \n  FROM (\n    SELECT\n          count(\"base_orders\".id) \"count\"\n        FROM\n          (SELECT * FROM 's3://cube-tutorial/orders.csv') AS \"base_orders\" \n  ) AS \"table\"\n) AS \"table\"\nLIMIT 50000",
      []
    ],
    "query_type": "pushdown"
  }
}

`{base_path}/v1/convert-query`

Takes an API query in the specified input format and converts it to the specified output format. Currently, only conversion from SQL API queries to REST (JSON) API queries is supported. This endpoint is useful for translating SQL API queries into equivalent REST (JSON) API queries that can be used with the /v1/load endpoint. Request parameters (JSON body):

Parameter, type	Description	Required
`input`, `string`	Input query format. Use `sql` for SQL API queries	✅ Yes
`output`, `string`	Output query format. Use `rest` for REST (JSON) API queries	✅ Yes
`query`, `string`	Input query in the specified format	✅ Yes

The response will contain a JSON object with the following properties:

Property, type	Description
`status`, `string`	Query conversion status, `ok` or `error`
`query`, `object`	Converted query in the REST (JSON) API query format (only present when `status` is `ok`)
`error`, `string`	Error message (only present when `status` is `error`)

An error will be returned if the input query can’t be converted to the specified output format, e.g., if the SQL API query requires post-processing on top of REST (JSON) API capabilities or if the SQL API query results in multiple REST (JSON) API queries.

Example

Request to convert a SQL API query with a filter:

curl \
  -X POST \
  -H "Authorization: TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"input": "sql", "output": "rest", "query": "SELECT MEASURE(total_amount) FROM orders WHERE status = '\''foo'\''"}' \
  http://localhost:4000/cubejs-api/v1/convert-query

Successful response:

{
  "status": "ok",
  "query": {
    "measures": [
      "orders.total_amount"
    ],
    "dimensions": [],
    "filters": [
      {
        "member": "orders.status",
        "operator": "equals",
        "values": ["foo"]
      }
    ],
    "segments": [],
    "order": []
  }
}

`{base_path}/v1/meta`

In Cube Cloud, consider using the Metadata API instead. It provides additional information such as data lineage.

Get meta-information for cubes and views defined in the data model. Information about cubes and views with public: false will not be returned. Response

cubes - Array of cubes and views
- name - Codename of the cube/view
- type - Type can be “cube” or “view”
- title - Human-readable cube/view name
- meta - Custom metadata
- measures - Array of measures in this cube/view
- dimensions - Array of dimensions in this cube/view
- hierarchies - Array of hierarchies in this cube
- segments - Array of segments in this cube/view
- folders and nestedFolders - Arrays of flat and nested folder structures in this view, respectively
- connectedComponent - An integer representing a join relationship. If the same value is returned for two cubes, then there is at least one join path between them.

Example request:

curl \
  -H "Authorization: TOKEN" \
  -G \
  http://localhost:4000/cubejs-api/v1/meta

Example response:

{
  "cubes": [
    {
      "name": "Users",
      "title": "Users",
      "meta": {
          "someKey": "someValue",
          "nested": {
            "someKey": "someValue"
          }
      },
      "connectedComponent": 1,
      "measures": [
        {
          "name": "users.count",
          "title": "Users Count",
          "shortTitle": "Count",
          "aliasName": "users.count",
          "type": "number",
          "aggType": "count",
          "drillMembers": ["users.id", "users.city", "users.createdAt"]
        }
      ],
      "dimensions": [
        {
          "name": "users.city",
          "title": "Users City",
          "type": "string",
          "aliasName": "users.city",
          "shortTitle": "City",
          "suggestFilterValues": true
        }
      ],
      "segments": []
    }
  ]
}

`{base_path}/v1/cubesql`

Run the query to the SQL API and get the results.

This endpoint is part of the SQL API.

Parameter	Description	Required
`query`	The SQL query to run	✅ Yes
`timezone`	The time zone for this query in the TZ Database Name format, e.g., `America/Los_Angeles`	❌ No
`cache`	See cache control. `stale-if-slow` by default	❌ No

Headers

Header	Description	Required
`Authorization`	API token for authentication	✅ Yes
`x-request-id`	Custom request identifier. When provided, this ID is used to track the query through the system and can be used to cancel the query. If not provided, a unique ID is generated automatically.	❌ No

Response: a stream of newline-delimited JSON objects. The first object contains the schema property with column names and types, and optionally lastRefreshTime indicating when the data was last refreshed. The following objects contain chunks of the result set under the data property. Each chunk includes one or more rows of the result set; the maximum number of rows per chunk is set by CUBESQL_CUBE_SCAN_MAX_BATCH_ROWS.

Example

Simple request:

curl \
  -X POST \
  -H "Authorization: TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"query": "SELECT 123 AS value UNION ALL SELECT 456 AS value UNION ALL SELECT 789 AS value"}' \
  http://localhost:4000/cubejs-api/v1/cubesql

Response:

{"schema":[{"name":"value","column_type":"Int64"}],"lastRefreshTime":"2025-01-13T12:00:00.000Z"}
{"data":[["789"]]}
{"data":[["123"]]}
{"data":[["456"]]}

Simple request with a query that returns multiple columns:

curl \
  -X POST \
  -H "Authorization: TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"query": "SELECT full_name, MEASURE(results_race_wins) AS wins, MEASURE(results_average_race_position) AS avg_position FROM session_results GROUP BY 1 ORDER BY 3 LIMIT 5"}' \
  http://localhost:4000/cubejs-api/v1/cubesql

Response:

{"schema":[{"name":"full_name","column_type":"String"},{"name":"wins","column_type":"Int64"},{"name":"avg_position","column_type":"Double"}],"lastRefreshTime":"2025-01-13T12:00:00.000Z"}
{"data":[["Max VERSTAPPEN","10","3.730769230769231"],["Lando NORRIS","4","4"],["Charles LECLERC","4","4.730769230769231"],["Oscar PIASTRI","3","4.8076923076923075"],["Andrea Kimi ANTONELLI","0","5"]]}

`{base_path}/v1/running-query/{requestId}`

Cancel a running query by its request ID. This endpoint cancels any in-flight queries matching the given request ID across all query queues. The request ID can be obtained from the x-request-id header sent with the original query request to endpoints like /v1/load or /v1/cubesql.

Parameter	Description	Required
`requestId`	The request ID of the query to cancel (URL path parameter)	✅ Yes

Response:

result — an array of cancelled query definitions. Empty array if no matching queries were found in the queue.

Example

Cancel a query:

curl \
  -X DELETE \
  -H "Authorization: TOKEN" \
  http://localhost:4000/cubejs-api/v1/running-query/my-request-id-span-1

Example response when a query was cancelled:

{
  "result": [
    {
      "queryHandler": "query",
      "queryKey": "...",
      "requestId": "my-request-id-span-1"
    }
  ]
}

Example response when no matching query was found:

{
  "result": []
}

`{base_path}/v1/pre-aggregations/jobs`

Trigger pre-aggregation build jobs or retrieve statuses of such jobs.

This endpoint is part of the Orchestration API.

Triggering jobs

Parameter	Description	Required
`action`	Use `post` to trigger jobs	✅
`selector.contexts`	Array of objects, each containing a `securityContext`	✅
`selector.timezones`	Array of timezones	✅
`selector.dataSources`	Array of data source names which have pre-aggregations defined	❌
`selector.cubes`	Array of cube names which contain pre-aggregations	❌
`selector.preAggregations`	Array of pre-aggregation names	❌
`selector.dateRange`	Date Range tuple [‘range-date-start’, ‘range-date-end’]	❌

To trigger pre-aggregation builds, send a POST request with a payload including post as the action and selector properties. The response will contain an array of tokens (identifiers) of triggered jobs. Example request triggering builds of all pre-aggregations defined in all cubes using an empty security context and a UTC timezone:

curl \
  -d '{
    "action": "post",
    "selector": {
      "contexts": [{ "securityContext": {} }],
      "timezones": ["UTC"]
    }
  }' \
  -H "Authorization: TOKEN" \
  -H "Content-Type: application/json" \
  -X POST \
  https://localhost:4000/cubejs-api/v1/pre-aggregations/jobs

Example request triggering builds of all pre-aggregations defined in the orders cube using an empty security context and a UTC timezone:

curl \
  -d '{
    "action": "post",
    "selector": {
      "contexts": [{ "securityContext": {} }],
      "timezones": ["UTC"],
      "cubes": ["orders"]
    }
  }' \
  -H "Authorization: TOKEN" \
  -H "Content-Type: application/json" \
  -X POST \
  https://localhost:4000/cubejs-api/v1/pre-aggregations/jobs

Example request triggering builds of the main pre-aggregation defined in the orders cube using an empty security context and a UTC timezone:

curl \
  -d '{
    "action": "post",
    "selector": {
      "contexts": [{ "securityContext": {} }],
      "timezones": ["UTC"],
      "preAggregations": ["orders.main"]
    }
  }' \
  -H "Authorization: TOKEN" \
  -H "Content-Type: application/json" \
  -X POST \
  https://localhost:4000/cubejs-api/v1/pre-aggregations/jobs

Example request triggering builds of the main pre-aggregation defined in the orders cube within date range with some security context data and an America/Los_Angeles timezone:

curl \
  -d '{
    "action": "post",
    "selector": {
      "contexts": [{ "securityContext": { "tenantId": "tenant1" } }],
      "timezones": ["America/Los_Angeles"],
      "preAggregations": ["orders.main"],
      "dateRange": ["2020-01-01", "2020-02-01"]
    }
  }' \
  -H "Authorization: TOKEN" \
  -H "Content-Type: application/json" \
  -X POST \
  https://localhost:4000/cubejs-api/v1/pre-aggregations/jobs

Example response:

[
  "e9a6a0c55885cea5371348500ce7d7dc",
  "d1329b6c8d152e734fc4dcf7307b1b58",
  "6f4ea38373663fffc4334a576574845b",
  "ea903b10634b2f3141b35a2529870e89"
]

Retrieving statuses of jobs

Parameter	Description	Required
`action`	Use `get` to retrieve statuses of previously triggered jobs	✅
`tokens`	Array of `tokens` returned when triggering jobs	✅
`resType`	Use `object` to get a JSON object instead of an array in response	❌

To retrieve statuses of previously triggered jobs, send a POST request with a payload including the tokens property. In the status property of the payload, you can get the following statuses:

Status	Description
`scheduled`	The job hasn’t run yet
`processing`	The job is currently running
`missing_partition`	The job has failed
`done`	The job has successfully completed

Example request:

curl \
  -d '{
    "action": "get",
    "tokens": [
      "e9a6a0c55885cea5371348500ce7d7dc",
      "d1329b6c8d152e734fc4dcf7307b1b58"
    ]
  }' \
  -H "Authorization: TOKEN" \
  -H "Content-Type: application/json" \
  -X POST \
  https://localhost:4000/cubejs-api/v1/pre-aggregations/jobs

Example response:

[
  {
    "token": "e9a6a0c55885cea5371348500ce7d7dc",
    "table": "prod_pre_aggregations.orders_category_and_date_hod0x3hf_03krd5ns_1hop3hn",
    "status": "processing",
    "selector": {
      "cubes": ["orders"],
      "preAggregations": ["orders.category_and_date"],
      "contexts": [{ "securityContext": { "tenant": "tenant_1" } }],
      "timezones": ["UTC"],
      "dataSources": ["default"]
    }
  },
  {
    "token": "d1329b6c8d152e734fc4dcf7307b1b58",
    "table": "prod_pre_aggregations.orders_category_and_date_mzfp445f_r2h2isa5_1hop3hn",
    "status": "processing",
    "selector": {
      "cubes": ["orders"],
      "preAggregations": ["orders.category_and_date"],
      "contexts": [{ "securityContext": { "tenant": "tenant_1" } }],
      "timezones": ["UTC"],
      "dataSources": ["default"]
    }
  }
]

Metadata API

Metadata API is only available in Cube Cloud.

These endpoints provide programmatic access to data model metadata for data catalogs, lineage tools, and other integrations. To access these endpoints, you need a JWT token which can be obtained via the Control Plane API.

`{base_path}/v1/data-sources`

Send a GET request to list configured data sources visible to the authenticated user. Example request:

curl \
  -H "Authorization: Bearer TOKEN" \
  https://example.cubecloud.dev/cubejs-api/v1/data-sources

Example response:

{
  "data": {
    "data_sources": [
      {
        "name": "default",
        "type": "postgres",
        "database": "analytics",
        "schema": "public"
      }
    ]
  }
}

`{base_path}/v1/entities`

Send a GET request to list all cubes and views in the data model. Results are sorted by type (cubes first), then by name. Each item contains only type and name; use /v1/entities/{name} or /v1/entities/all for detailed metadata. Query parameters:

Parameter	Description	Required
`offset`	Pagination offset. Defaults to `0`	No
`limit`	Maximum number of items to return. Defaults to all items	No

Example request:

curl \
  -H "Authorization: Bearer TOKEN" \
  "https://example.cubecloud.dev/cubejs-api/v1/entities?limit=10"

Example response. data is an array of entities; pagination reports the total number of entities before offset and limit are applied:

{
  "data": [
    {
      "type": "cube",
      "name": "orders"
    },
    {
      "type": "view",
      "name": "orders_view"
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 10,
    "total": 2
  }
}

`{base_path}/v1/entities/{name}`

Send a GET request to get detailed metadata for a single cube or view. Path parameters:

Parameter	Description
`name`	The cube or view name

Response includes:

type - Either cube or view
name - The cube or view name
title - Human-readable title
description - Description from the data model, or an empty string
table_references - Data lineage to source tables, each with data_source, table, and, if the table is qualified, schema
cube_references - Relationships to other cubes, each as an object with type (currently always upstream) and cube
measures and dimensions - Arrays of members, sorted by name

Each member includes:

Field	Description
`name`	The member name, without the cube prefix
`title`	Human-readable title
`description`	Description from the data model, or an empty string
`type`	The member type, e.g. `count`, `sum`, or `string`
`sql`	The member’s SQL definition (see below). Omitted when it can’t be resolved
`is_primary_key`	Whether the dimension is a primary key. Dimensions only
`member_references`	Upstream members the member is derived from, each with `cube` and `member`
`column_references`	Source columns, each with `data_source`, `table`, `column`, and, if the table is qualified, `schema`

sql is the member’s SQL expression as written in the data model, with any enclosing quotes removed — for example COUNT(*), ${CUBE}.status, or ${total_amount} - ${refunds}. References to other members appear as ${member} interpolations, and ${CUBE} refers to the cube’s own table alias. Members of a view carry the alias expression they resolve to, e.g. ${orders.total_amount}. Example request:

curl \
  -H "Authorization: Bearer TOKEN" \
  https://example.cubecloud.dev/cubejs-api/v1/entities/orders

Example response:

{
  "data": {
    "type": "cube",
    "name": "orders",
    "title": "Orders",
    "description": "Order transactions",
    "table_references": [
      {
        "data_source": "default",
        "schema": "public",
        "table": "orders"
      }
    ],
    "cube_references": [],
    "measures": [
      {
        "name": "total_amount",
        "title": "Total Amount",
        "description": "",
        "type": "sum",
        "sql": "${CUBE}.amount",
        "member_references": [],
        "column_references": [
          {
            "data_source": "default",
            "schema": "public",
            "table": "orders",
            "column": "amount"
          }
        ]
      }
    ],
    "dimensions": [
      {
        "name": "id",
        "title": "Id",
        "description": "",
        "type": "number",
        "sql": "${CUBE}.id",
        "is_primary_key": true,
        "member_references": [],
        "column_references": [
          {
            "data_source": "default",
            "schema": "public",
            "table": "orders",
            "column": "id"
          }
        ]
      },
      {
        "name": "status",
        "title": "Status",
        "description": "",
        "type": "string",
        "sql": "${CUBE}.status",
        "is_primary_key": false,
        "member_references": [],
        "column_references": [
          {
            "data_source": "default",
            "schema": "public",
            "table": "orders",
            "column": "status"
          }
        ]
      }
    ]
  }
}

`{base_path}/v1/entities/all`

Send a POST request to get detailed metadata for multiple cubes and views in one request. Request body:

Property	Type	Description	Required
`cubes`	`array`	Array of cube names to retrieve	No
`views`	`array`	Array of view names to retrieve	No

Query parameters:

Parameter	Description	Required
`offset`	Pagination offset. Defaults to `0`	No
`limit`	Maximum number of items to return. Defaults to all items	No

If neither cubes nor views is provided, all cubes and views are returned. Example request:

curl \
  -X POST \
  -H "Authorization: Bearer TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"cubes": ["orders"], "views": ["orders_view"]}' \
  https://example.cubecloud.dev/cubejs-api/v1/entities/all

Example response. data is an array of entities, each in the same format as the single-entity response above; pagination reports the total number of matching entities before offset and limit are applied:

{
  "data": [
    {
      "type": "cube",
      "name": "orders",
      "title": "Orders",
      "description": "Order transactions",
      "table_references": [
        {
          "data_source": "default",
          "schema": "public",
          "table": "orders"
        }
      ],
      "cube_references": [],
      "measures": [
        {
          "name": "total_amount",
          "title": "Total Amount",
          "description": "",
          "type": "sum",
          "sql": "${CUBE}.amount",
          "member_references": [],
          "column_references": [
            {
              "data_source": "default",
              "schema": "public",
              "table": "orders",
              "column": "amount"
            }
          ]
        }
      ],
      "dimensions": [
        {
          "name": "id",
          "title": "Id",
          "description": "",
          "type": "number",
          "sql": "${CUBE}.id",
          "is_primary_key": true,
          "member_references": [],
          "column_references": [
            {
              "data_source": "default",
              "schema": "public",
              "table": "orders",
              "column": "id"
            }
          ]
        },
        {
          "name": "status",
          "title": "Status",
          "description": "",
          "type": "string",
          "sql": "${CUBE}.status",
          "is_primary_key": false,
          "member_references": [],
          "column_references": [
            {
              "data_source": "default",
              "schema": "public",
              "table": "orders",
              "column": "status"
            }
          ]
        }
      ]
    },
    {
      "type": "view",
      "name": "orders_view",
      "title": "Orders View",
      "description": "",
      "table_references": [
        {
          "data_source": "default",
          "schema": "public",
          "table": "orders"
        }
      ],
      "cube_references": [
        { "type": "upstream", "cube": "orders" }
      ],
      "measures": [
        {
          "name": "total_amount",
          "title": "Total Amount",
          "description": "",
          "type": "sum",
          "sql": "${orders.total_amount}",
          "member_references": [
            { "cube": "orders", "member": "total_amount" }
          ],
          "column_references": [
            {
              "data_source": "default",
              "schema": "public",
              "table": "orders",
              "column": "amount"
            }
          ]
        }
      ],
      "dimensions": [
        {
          "name": "status",
          "title": "Status",
          "description": "",
          "type": "string",
          "sql": "${orders.status}",
          "is_primary_key": false,
          "member_references": [
            { "cube": "orders", "member": "status" }
          ],
          "column_references": [
            {
              "data_source": "default",
              "schema": "public",
              "table": "orders",
              "column": "status"
            }
          ]
        }
      ]
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 2,
    "total": 2
  }
}

Health checks

`/readyz`

Reports if the deployment has successfully started. To do so, it will try to test the connection to the default data source. Example of a successful request:

curl -i http://localhost:4000/readyz
HTTP/1.1 200 OK
X-Powered-By: Express
Access-Control-Allow-Origin: *
Content-Type: application/json; charset=utf-8
Content-Length: 19
ETag: W/"13-MyluqxoYxC0tUxBeZCnbaWYVLhg"
Date: Mon, 18 Jan 2021 15:39:57 GMT
Connection: keep-alive
Keep-Alive: timeout=5

{"health":"HEALTH"}

Example of a failed response:

curl -i http://localhost:4000/readyz
HTTP/1.1 500 Internal Server Error
X-Powered-By: Express
Access-Control-Allow-Origin: *
Content-Type: application/json; charset=utf-8
Content-Length: 19
ETag: W/"13-MyluqxoYxC0tUxBeZCnbaWYVLhg"
Date: Mon, 18 Jan 2021 15:39:57 GMT
Connection: keep-alive
Keep-Alive: timeout=5

{"health":"DOWN"}

`/livez`

Reports if the deployment is still healthy. This is confirmed by testing any existing connections to data sources. Example of a successful response:

curl -i http://localhost:4000/livez
HTTP/1.1 200 OK
X-Powered-By: Express
Access-Control-Allow-Origin: *
Content-Type: application/json; charset=utf-8
Content-Length: 19
ETag: W/"13-MyluqxoYxC0tUxBeZCnbaWYVLhg"
Date: Mon, 18 Jan 2021 15:39:57 GMT
Connection: keep-alive
Keep-Alive: timeout=5

{"health":"HEALTH"}

Example of a failed response:

curl -i http://localhost:4000/livez
HTTP/1.1 500 Internal Server Error
X-Powered-By: Express
Access-Control-Allow-Origin: *
Content-Type: application/json; charset=utf-8
Content-Length: 19
ETag: W/"13-MyluqxoYxC0tUxBeZCnbaWYVLhg"
Date: Mon, 18 Jan 2021 15:39:57 GMT
Connection: keep-alive
Keep-Alive: timeout=5

{"health":"DOWN"}

Data Modeling

Configuration

Core Data APIs

Embed APIs

Other APIs

Cube Store

CLI

JavaScript SDK

`{base_path}/v1/load`

Headers

`{base_path}/v1/sql`

Example

`{base_path}/v1/convert-query`

Example

`{base_path}/v1/meta`

`{base_path}/v1/cubesql`

Headers

Example

`{base_path}/v1/running-query/{requestId}`

Example

`{base_path}/v1/pre-aggregations/jobs`

Triggering jobs

Retrieving statuses of jobs

Metadata API

`{base_path}/v1/data-sources`

`{base_path}/v1/entities`

`{base_path}/v1/entities/{name}`

`{base_path}/v1/entities/all`

Health checks

`/readyz`

`/livez`

​{base_path}/v1/load

​Headers

​{base_path}/v1/sql

​Example

​{base_path}/v1/convert-query

​Example

​{base_path}/v1/meta

​{base_path}/v1/cubesql

​Headers

​Example

​{base_path}/v1/running-query/{requestId}

​Example

​{base_path}/v1/pre-aggregations/jobs

​Triggering jobs

​Retrieving statuses of jobs

​Metadata API

​{base_path}/v1/data-sources

​{base_path}/v1/entities

​{base_path}/v1/entities/{name}

​{base_path}/v1/entities/all

​Health checks

​/readyz

​/livez

`{base_path}/v1/load`

Headers

`{base_path}/v1/sql`

Example

`{base_path}/v1/convert-query`

Example

`{base_path}/v1/meta`

`{base_path}/v1/cubesql`

Headers

Example

`{base_path}/v1/running-query/{requestId}`

Example

`{base_path}/v1/pre-aggregations/jobs`

Triggering jobs

Retrieving statuses of jobs

Metadata API

`{base_path}/v1/data-sources`

`{base_path}/v1/entities`

`{base_path}/v1/entities/{name}`

`{base_path}/v1/entities/all`

Health checks

`/readyz`

`/livez`