Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The Notification Template to report on — its ID (nt_ prefix) or an alias. Must not contain commas or whitespace.

Minimum string length: 1

Query Parameters

granularity
enum<string>
default:DAY

The size of each bucket in the series. Defaults to DAY. WEEK buckets start on Sunday. A fine granularity caps the window it can cover: HOUR spans at most 7 days and DAY at most 90 days, and a wider window returns 400 — request a coarser granularity instead. WEEK and MONTH are uncapped, subject to the 1000-bucket limit on a single response.

Available options:
HOUR,
DAY,
WEEK,
MONTH
lookback
string
default:P30D

The length of the window, counted back from now, as an ISO 8601 duration (P30D, P12W, PT12H). Defaults to P30D, and is ignored when start and end are supplied. A malformed or non-positive duration returns 400.

start
string<date-time>

The inclusive start of the window, as an ISO 8601 timestamp with an offset (2026-04-01T00:00:00Z). Must be supplied together with end and be earlier than it; either one alone returns 400.

end
string<date-time>

The end of the window, as an ISO 8601 timestamp with an offset. Must be supplied together with start. An end in the future is accepted and not clamped — the trailing buckets come back empty.

Response

The delivery funnel for the Notification Template, bucketed over the resolved window.

notificationId
string
required

The template the series describes, echoed from the request.

granularity
enum<string>
required

Bucket size the series was built at.

Available options:
HOUR,
DAY,
WEEK,
MONTH
start
string<date-time>
required

Inclusive start of the window actually queried, floored onto the granularity grid. Second-precision UTC.

end
string<date-time>
required

End of the window actually queried, ceiled onto the granularity grid. Second-precision UTC.

series
NotificationMetricsBucket · object[]
required

One entry per bucket between start and end, oldest first, including buckets with no activity.