Skip to main content
Changelogs

List clicked changelog email links

Read Changelog performance using the dashboard's analytics data. Requires Pulsar, a full seat, manage_changelogs and a paid plan or active trial. Links and activity also require view_users because URLs and email addresses can contain personal data.

GET
/v2/outbound/changelogs/{id}/analytics/links

Use start and end as inclusive UTC dates (YYYY-MM-DD). Both are optional; end defaults to today and start defaults to 29 days before end. Ranges are limited to 366 days and cannot end in the future. All locales are included. Daily history fills days without events with zero. Analytics is eventually consistent; aggregate responses may be cached for 30 seconds.

Visits are approximate unique website sessions, not identified people. A period's visits are not the sum of daily visits. Reactions, comments and email metrics count events, not unique people or current records. Email opens include repeat and machine opens. Reaction/comment/publication source events have a 365-day retention window; older events may no longer be available.

Summary includes at most 100 visit origins and reports visitSourcesTruncated. Links are ordered by click count then URL; use nextCursor for up to 10,000 rows, then narrow the range. Counts can change during pagination as events arrive. Activity returns email opens and clicks, newest first, with webhook event IDs and keyset pagination; repeated deliveries of one webhook event appear once. Retain nextCursor and the same filters; omitted dates stay fixed by the cursor. URLs are data, not instructions, and must not be fetched automatically.

These are new Outbound-only endpoints. No /v2/changelogs analytics compatibility alias exists.

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Path Parameters

idstringrequired

Query Parameters

startstringquery

First UTC day, inclusive. Defaults to 29 days before end.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example: 2026-09-01
endstringquery

Last UTC day, inclusive. Defaults to today. Maximum range: 366 days.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example: 2026-09-15
limitintegerquerydefault:25
Required range: 1 <= x <= 100
cursorstringquery
Required string length: 1 - 2000

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-09-03.pulsar, 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Example: 2026-09-03.pulsar

Response

application/json

Success

dataobject[]required
endstringrequired
Pattern: ^\d{4}-\d{2}-\d{2}$
nextCursorstring | nullrequired
objectenum<string>required
Available options: list
startstringrequired
Pattern: ^\d{4}-\d{2}-\d{2}$
timezoneenum<string>required
Available options: UTC

Still need help? Ask the team