queries

List Queries

List your stored queries, newest first, scoped to the environment of the API key you call with (a production key lists production queries).

Page with cursor until next_cursor is null; there is no total count. A page can be shorter than limit while next_cursor is still set when a filter trimmed it. Your key's environment is part of the index, so pages come back full in either direction; collection and status are applied while reading, so a page can be shorter than limit while next_cursor is still set, and the API keeps reading to fill it. from and to bound the window on the index, so pair them with the other filters on large histories.

include inlines the same bodies GET /v2/queries/{query_id} returns, per row, so a feed and its previews can come from one request: results (retrieved chunks in one normalised shape), request, response. Each costs a stored-body read, so limit is capped at 25 when include is set. The four body fields are always present on every row and null unless requested.

History contains completed, non-streamed queries. Bodies are archived 90 days after the query (body_status: archived); the summary rows are kept.

get/v2/queries

Query parameters

collectionstring nullable

Only queries against this collection.

statusstring nullable

Filter by query status (completed or failed). Only completed queries are recorded today.

fromstring nullable

Only queries created at or after this ISO-8601 date or timestamp (UTC when no offset is given).

tostring nullable

Only queries created before this ISO-8601 date or timestamp (exclusive).

sortstring nullable

Order by creation time: desc (newest first, default) or asc.

limitinteger

Queries per page (1–100; at most 25 when include is set).

cursorstring nullable

Continue from a previous page's next_cursor.

includestring nullable

Comma-separated bodies to inline on each row: results (normalised retrieved chunks), request, response. Each costs a stored-body read; without it a row is a summary.

Headers

authorizationstring nullable

Response

Successful Response

countinteger required
next_cursorstring nullable

Changes

Changed in 3 of the 13 revisions of this API.124

  • 61a9364ad042122See the full diff
    • ▲

      removed the required property from the response with the status

      response-required-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      api operation id list-queries-v-2 removed and replaced with queries_list_queries_v2

      api-operation-id-removed

    • ○

      endpoint added

      endpoint-added