Skip to content
Authrim

Get DLQ item payload preview

GET
/api/admin/logging-policies/dlq-items/{id}/payload
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/logging-policies/dlq-items/example/payload?preview_bytes=8192' \
  --header 'Authorization: Bearer <token>'

Returns DLQ item metadata plus a bounded payload preview. The preview size is capped by the API.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Query Parameters

Section titled “Query Parameters ”
preview_bytes
integer
default: 8192 >= 1 <= 65536

Maximum payload preview bytes to return.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
item
required
object
key
additional properties
key
additional properties
Example 
{
  "item": {
    "id": "dlq_123",
    "tenant_key": "tenant_123",
    "payload_type": "retry_delivery",
    "schema_version": 1,
    "lane": "default",
    "destination_id": "dest_123",
    "payload_object_ref": "r2://logging-dlq/dlq_123.json",
    "error_class": "delivery_failed",
    "attempt_count": 3,
    "status": "open",
    "created_at": 1770000000,
    "updated_at": 1770000000,
    "payload": {
      "preview": {
        "payload_type": "retry_delivery"
      },
      "truncated": false,
      "preview_bytes": 8192
    }
  }
}

default

Section titled “default ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}