DocumentationAnalytics

Analytics

Summary KPIs, daily trends, and top templates from the dashboard and API.

The Analytics section in the dashboard visualizes send volume, opens, clicks, and template performance. Under the hood it calls JWT-protected analytics endpoints (not available with API keys alone).

Endpoints

EndpointReturns
GET /analytics/summaryAggregate KPIs for the tenant (sent, delivered, opened, clicked, bounced)
GET /analytics/dailyTime series bucketed by day
GET /analytics/top-templatesTemplates ranked by sends or engagement

Summary example

GET /analytics/summary?from=2026-06-01&to=2026-06-30
Authorization: Bearer <accessToken>
X-Tenant-Id: clxxxxxxxx

Typical response fields include counts and rates for the selected period. Exact schema is in the OpenAPI reference.

Daily trends

GET /analytics/daily?from=2026-06-01&to=2026-06-30

Use for charts in the dashboard or your own reporting if you proxy with a server-side JWT.

Top templates

GET /analytics/top-templates?limit=10&from=2026-06-01&to=2026-06-30

Identifies which published templates drive the most engagement.

Dashboard vs API

  • Dashboard — pre-built charts, date picker, no code
  • API — export to BI tools; requires admin session token

For programmatic email logs (per message), use GET /emails/logs with an API key scoped email:read.