---
title: "Retrieve the delivery overview"
method: GET
path: "/api/v1/webhook-endpoints/overview"
tags: ["Webhook deliveries"]
---

# Retrieve the delivery overview

`GET /api/v1/webhook-endpoints/overview`

## Request

- Base URL: `https://api.sudomock.com`
- URL: `https://api.sudomock.com/api/v1/webhook-endpoints/overview`
- Auth: API key in header `x-api-key`

Window-scoped delivery rollup spanning every endpoint the caller owns: global total/failed COUNTs, a per-day sparkline, and a per-endpoint breakdown (total/failed/last_activity). The path is 'overview', not an endpoint id.

## Query parameters

- `period_days` integer: How many days back the rollup reaches, covering the totals, the daily counts, and the per endpoint breakdown.
- `tz_offset_minutes` integer: Minutes to shift the daily buckets from UTC, so counts line up with your local day.

## Response `200`

Successful Response

- WebhookOverviewResponse: Delivery rollup covering every endpoint you own, for the window you asked for.
  - `global` WebhookOverviewTotals, required: Delivery counts for the whole window, across every endpoint you own.
    - `total` integer, required: How many deliveries were recorded across the window.
    - `failed` integer, required: How many of those deliveries ended without your endpoint accepting them.
    - `days` WebhookOverviewDay[], required: Day by day counts ready to plot, where a day with no deliveries can be missing.
      - `date` string, required: Calendar day these counts belong to.
      - `total` integer, required: How many deliveries were recorded on this day.
      - `failed` integer, required: How many of that day's deliveries ended without your endpoint accepting them.
  - `by_endpoint` object, required: Counts for each endpoint you own, keyed by its id.

---

[API](https://skmtc.dev/sudomock/apis/sudomock-api.md) · [All operations](https://skmtc.dev/sudomock/apis/sudomock-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sudomock/apis/sudomock-api/revisions/c1cc24006c60?raw)