v14

OpenAPI 3.1.02026-08-03122113375.9 KB
seller-webhooks

Get delivery metrics

Retrieve aggregated webhook delivery metrics for the authenticated seller.

Use this endpoint to monitor webhook reliability over time and detect delivery regressions across event types.

Query behavior:

  • Accepts a 'range' parameter controlling how much historical data is returned.
  • If omitted, the default range is used by the API.

Returned data is designed for dashboards and alerting workflows, including:

  • Time-bucketed event series.
  • Separation by webhook event type.
  • Delivery outcome trends across the selected time window.

Recommended monitoring workflow:

  1. Query metrics on a regular schedule (for example, dashboard refresh intervals).
  2. Detect spikes in failures or drops in successful deliveries.
  3. Pivot to /failures endpoints for endpoint-level investigation.
  4. Re-run metrics after remediation to confirm recovery.
get/seller/webhooks/metrics

Query parameters

range'1M' | '3M' | '6M' | '1Y'

Time range describing how much historical data should be returned

Time range describing how much historical data should be returned

Response

Aggregated webhook metrics for the authenticated seller

timestring required

ISO timestamp for the interval