Skip to main content
GET
Get a Query History request
One API request with the SQL it generated, to the data source and to Cube Store, and how long each query waited and ran. Covers the deployment’s production API requests that queried data (REST, GraphQL, SQL and WebSocket), as the Query History page in Cube Cloud shows them; requests to development branches and metadata calls are left out. How far back it reaches is the deployment’s Query History retention.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId
integer
required
id
string
required

The id a listed request carries: <epochMs>-<spanId>.

Response

200 - application/json
cacheType
string
required

Where the answer came from: cube (a pre-aggregation in Cube Store), cube-suboptimal (Cube Store with a suboptimal plan), base (the data source), internal (Cube’s in-memory cache) or none.

id
string
required

Pass to GET …/query-history/requests/{id}. It is the id in the request’s Query History link in Cube Cloud, not requestId.

isPlayground
boolean
required
isSubscription
boolean
required
requestId
string
required

The request id the client sent or Cube assigned.

spanId
string
required
sqlQueries
object[]
required

The SQL the request generated, oldest first: up to 100 queries, each to the data source or Cube Store.

status
enum<string>
required

success, error, running (no response yet), or noResponse (no response, and silent for five minutes).

Available options:
success,
error,
running,
noResponse
timestamp
string
required

When the request arrived, ISO 8601 UTC.

usedPreAggregations
boolean
required
apiType
string | null

rest, graphql, sql or ws.

durationMs
number | null

Time to the API response.

error
string | null
preAggregations
string | null

The pre-aggregations the request used, as APM recorded them.

query
string | null

The query as the API received it: REST query JSON, or the SQL text.

responseBytes
number | null
securityContext
string | null

The security context JSON.