Sign in
Adhoc Retrievers

List Adhoc Executions

List execution history for ad-hoc retrievers.

Returns execution history for all ad-hoc retriever executions in the namespace, sorted by timestamp descending (most recent first).

Use Cases: - Track ad-hoc retriever usage across the namespace - Debug ad-hoc retriever executions - Analyze query patterns from ad-hoc searches - Monitor performance of ad-hoc executions

Filtering: - Filter by status (completed, failed, etc.) - Filter by time range (start_time, end_time)

Pagination: - Supports offset-based pagination via query parameters - Default limit: 20, max limit: 100 - Use ?page_size=X&page_number=Y for pagination

post/v1/retrievers/executions/list

Query parameters

limitinteger nullable
page_sizeinteger nullable
offsetinteger nullable
pageinteger nullable
cursorstring nullable
next_cursorstring nullable
afterstring nullable
include_totalboolean

Request body

statusstring nullable

Filter by execution status. Common values: 'completed', 'failed'. OPTIONAL - omit to see all statuses.

{"stackTrail":"components:schemas:ListAdhocExecutionsRequest:properties:start_time:anyOf","oasType":"schema","type":"unknown","title":"Start Time","description":"Filter executions after this timestamp (inclusive). OPTIONAL - omit for no start time filter.","nullable":true}
{"stackTrail":"components:schemas:ListAdhocExecutionsRequest:properties:end_time:anyOf","oasType":"schema","type":"unknown","title":"End Time","description":"Filter executions before this timestamp (inclusive). OPTIONAL - omit for no end time filter.","nullable":true}
count_onlyboolean

BACKE-3071: when true, return ONLY the total count and skip fetching the execution rows. Use for a badge/total (the Executions-tab count) — it avoids the ORDER BY full-row scan that made a limit:1 count take 15s+.

Example request

{
  "status": "completed"
}

Response

Successful Response

totalinteger

Total number of ad-hoc executions matching filters.

{"stackTrail":"components:schemas:ListAdhocExecutionsResponse:properties:pagination","oasType":"schema","type":"unknown","title":"Pagination","description":"Pagination metadata."}

Changes

Changed in 3 of the 29 revisions of this API.4

  • 5d4c905106b41See the full diff
    • ○

      the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API

      api-security-added

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

  • 9603dfdab4631See the full diff
    • ○

      added the new optional request property count_only

      new-optional-request-property

  • 72cc17ba6f7f2See the full diff
    • ○

      added the new optional query request parameter after

      new-optional-request-parameter

    • ○

      added the new optional query request parameter next_cursor

      new-optional-request-parameter