v2

OpenAPI 3.0.02026-08-051996591.2 MB

Pipeline Dead Letters

List dead letters

Lists dead letters for a pipeline, with optional filtering by status or run.

get/v2/pipelines/{pipeline_key}/dead_letters

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.

Query parameters

status'pending' | 'retrying'

The status of a dead letter entry.

Filter dead letters by status.

last_run_idstring

The unique identifier for a pipeline run.

Example:run_pip_abc_manual_550e8400

Filter dead letters to those from a specific run.

origin'pipeline' | 'manual'

How this dead letter was created.

Filter dead letters by origin.

filterstring

A regex filter on the source record ID. Supports partial matching.

limitinteger

The maximum number of dead letters 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 dead letters.

Example response

{
  "dead_letters": [
    {
      "id": "pdl_a1b2c3d4-e5f6-7890-abcd-ef0123456789",
      "last_run_id": "run_pip_abc_manual_550e8400"
    }
  ],
  "metadata": {
    "page_key": "eyJvZmZzZXQiOjF9"
  }
}