v3

latestOpenAPI 3.0.02026-08-081996601.2 MB

Pipeline Runs

List pipeline run events

Lists the timeline of events for a pipeline run, keyed by run_id. Events report what the run did — records discovered, records processed, agent sessions created, dead letters, watermark advances, and lifecycle transitions. The terminal run_completed event is present once a run finishes. A run that ended abruptly surfaces as failed. The event agrees with the run's status field, which is the authoritative terminal signal.

get/v2/pipelines/{pipeline_key}/runs/{run_id}/events

Path parameters

pipeline_keystring required

The unique key for the pipeline. You can provide the key, or the platform generates one.

Example:sharepoint-legal-ingest

The unique key of the pipeline.

run_idstring required

The unique identifier for a pipeline run.

Example:run_pip_abc_manual_550e8400

The unique identifier of the run.

Query parameters

typePipelineRunEventType[]

Filter to one or more event types. Repeat the parameter to pass multiple values.

source_record_idstring

Filter to events for a specific source record.

order'asc' | 'desc'

Sort direction for paginated list endpoints.

Order events by timestamp. Defaults to newest-first.

limitinteger

The maximum number of events to return.

page_keystring

The opaque cursor returned in metadata.page_key of the previous response. Omit it to fetch the first page.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

List of pipeline run events.

Example response

{
  "events": [
    {
      "id": "evt_42",
      "agent_key": "customer_support"
    }
  ],
  "metadata": {
    "page_key": "eyJvZmZzZXQiOjF9"
  }
}