Skip to main content

Get query data

GET 
/v1/query

Returns a paginated list of queries with optional filtering.

Request​

Query Parameters

    page number

    Page number (1-indexed). Defaults to 1.

    size number

    Number of results per page. Defaults to 20.

    queryId string

    Filter by a specific query ID.

    showCanaries boolean

    Whether to include canary queries.

    startDate string

    Start of date range filter. Accepts strings in the format YYYY-MM-DDTHH:mm:ss.sssZ with possibly omitted parts, e.g. YYYY-MM-DD.

    Example: 2026-01-01T19:00:00.123456Z
    endDate string

    End of date range filter. Accepts strings in the format YYYY-MM-DDTHH:mm:ss.sssZ with possibly omitted parts, e.g. YYYY-MM-DD.

    Example: 2026-01-01T20:35:00.700000Z
    sort string

    Sort column. Prefix with - for descending order (e.g. -startTime), and just put the parameter name for ascending order (e.g., startTime).

    status string[]

    Possible values: [running, failed, successful]

    Filter by query status.

    modelId string[]

    Filter by model ID.

    catalogId string[]

    Filter by catalog ID.

    userId string[]

    Filter by user ID.

    queryType string[]

    Possible values: [System, User]

    Query origin type filter.

Header Parameters

    Authorization string

Responses​

A paginated list of queries.

Schema

    results

    object[]

    required

  • Array [

    • status stringrequired

    Possible values: [running, failed, successful]

    modelId stringrequired
    modelName string
    catalogId stringrequired
    catalogName string
    startTime numberrequired
    duration numberrequired
    userId stringrequired
    user string
    optimization string[]required

    Possible values: [AGGS, CACHE]

    attributes string[]required
    measures string[]required
    aggregates string[]required
    aggregatesTables string[]required
    queryType string

    Possible values: [System, User]

    queryId stringrequired
    dialect string

    Possible values: [Iris, Postgresql, Redshift, Snowflake, BigQuery, DatabricksSpark, DatabricksSQL, H2, Hive, Impala]

    dialectVersion string
    queryPlan string

    events

    object[]

  • Array [

    • name stringrequired

    Possible values: [Inbound Query, Planning, Outbound, Result Processing]

    startTime numberrequired
    duration numberrequired
    queryId string

    subqueries

    object[]

  • Array [

    • name stringrequired
    startTime numberrequired
    duration numberrequired
    subqueryId string

  • ]

  • ]

    • failedMessage string

  • ]

    • totalResults stringrequired
    hasNextPage booleanrequired
    currentPage numberrequired
    pageSize numberrequired
Loading...