Skip to main content

Diagnostics API

Inspect request and delivery diagnostics for support and integration debugging.

Use This API To

  • Look up request-scoped usage, events, deliveries, streams, and artifacts.
  • Summarize webhook and stream delivery activity over a time window.
  • Share precise troubleshooting context with SEC API support.

Before You Call

1

Start with the Request-Id from the API response or logs

Start with the Request-Id from the API response or logs.
2

Use delivery summaries for webhook or stream troubleshooting

Use delivery summaries for webhook or stream troubleshooting.
3

Avoid logging secrets when sharing diagnostics with support

Avoid logging secrets when sharing diagnostics with support.

Endpoints

GET /v1/diagnostics/deliveries/summary

Return aggregated webhook and stream delivery summaries for customer support workflows

GET /v1/diagnostics/requests/{request_id}

Return request-id scoped diagnostics across usage, events, deliveries, streams, and artifacts