Endpoint
Scopes
Requires one of:logs:readwebhooks:readorwebhooks:manage
Platform API
Metrics (overview)
API, webhook, and deliverability aggregates for a date range — without exporting every log line.
Was this page helpful?
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
API, webhook, and deliverability aggregates for a date range — without exporting every log line.
GET https://api.notifique.dev/v1/metrics/overview?startDate=2026-01-01&endDate=2026-01-31
Authorization: Bearer sk_live_...
logs:readwebhooks:read or webhooks:manage| Parameter | Description |
|---|---|
startDate | Optional ISO 8601 (default: ~30 days ago) |
endDate | Optional ISO 8601 (default: now) |
{
"success": true,
"data": {
"range": { "startDate": "...", "endDate": "..." },
"api": {
"requests": 1200,
"failures": 12,
"successRate": 99.0,
"avgDurationMs": 145.2
},
"webhooks": {
"deliveries": 800,
"failures": 4,
"successRate": 99.5
},
"deliverability": { }
}
}
Was this page helpful?