Notify API reference

Notify API · Stats

get/v1/workspaces/{workspace_id}/statsAuth

Get Notify stats

Daily delivery counts per channel for a range of UTC days (default the last 30, at most 90): planned, sent, delivered, failed, skipped, and inbox items read. Counted by the day a delivery was planned, from an hourly rollup: today and yesterday are refreshed every hour, so the newest counts can be up to an hour old (`updated_at`). Kept beyond the 30 days that delivery history is kept.

Path parameters

workspace_id*string · uuid

Id of the workspace.

Query parameters

fromstring · date

First UTC day (inclusive). Default: 29 days before `to`.

tostring · date

Last UTC day (inclusive). Default: today. At most 90 days after `from`.

Response · 200 The stats.

from*string · date

First day of the range.

Example: "2026-11-01"

to*string · date

Last day of the range.

Example: "2026-11-10"

data*array

One row per day and channel that had deliveries, oldest first. Days without deliveries are absent.

totals*object

The range summed over every day and channel.

updated_at*string · date-time

When the rollup last wrote this range (it runs hourly; today and yesterday are refreshed each time). Null when nothing was rolled up yet.

Example: "2026-11-10T09:05:00.000Z"

Example

Request

GET https://api.notify.productcraft.co/v1/workspaces/{workspace_id}/stats
Authorization: Bearer YOUR_TOKEN

Response

{
  "from": "2026-11-01",
  "to": "2026-11-10",
  "data": [
    {
      "accepted": 120,
      "sent": 96,
      "delivered": 40,
      "failed": 2,
      "skipped": 22,
      "read": 18,
      "day": "2026-11-10",
      "channel": "push"
    }
  ],
  "totals": {},
  "updated_at": "2026-11-10T09:05:00.000Z"
}