Skip to main content
POST
JSON query

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).

Headers

x-request-id
string

Request id for tracing; for security, it must be unique and unpredictable, e.g., a random UUID. A request with an invalid id is rejected with 400. Generated when neither this header nor traceparent is sent.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9+/=._:@~-]+$
traceparent
string

W3C trace context header, used as the request id when x-request-id is absent. Same rules as x-request-id.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9+/=._:@~-]+$

Body

application/json
queryType
string
cache
enum<string>
Available options:
stale-if-slow,
stale-while-revalidate,
must-revalidate,
no-cache
query
object

Response

successful operation

results
object[]
required
pivotQuery
object
slowQuery
boolean
queryType
string