Skip to main content

Documentation Index

Fetch the complete documentation index at: https://cometchat-22654f5b-docs-campaigns-service-rest-api.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

The Campaigns analytics surface gives you visibility into how notifications perform after they leave the system. Metrics are available in the Dashboard and through the analytics API, broken down by three primary dimensions.

Dimensions

Campaigns

Track delivery and engagement at the campaign level. Useful for comparing the performance of different sends, A/B testing subject lines, or evaluating whether a scheduled campaign hit its target audience.

Templates

Measure how a specific template performs across all sends that use it. Since every notification flows through a template, this is the most granular content-level view. Compare open rates between an “order shipped” template and a “weekly digest” template to understand which content resonates.

Channels

Evaluate per-channel effectiveness. If your app uses both in-app and push, the channel dimension shows which channel drives more engagement and where delivery failures concentrate.

Tags

Group notifications by any free-form label set on the template (transactional, launch, re-engagement, team or campaign cohort). Tags cut across templates and channels, so they’re the right dimension when you want a marketing-style rollup without forcing one template per cohort.

Metrics tracked

MetricDescription
RequestedNotifications dispatched to the delivery layer for this channel.
DeliveredConfirmed delivered to the user (device acknowledgement or feed write).
ViewedUser scrolled the item into view or opened the notification.
ClickedUser tapped a CTA or link within the notification.
InteractedUser performed a custom interaction (e.g. dismissed, snoozed, replied).
FailedDelivery failed (provider error, invalid token, user not reachable).

Per-user insights

You can also query engagement at the individual user level. This returns aggregate counts for a specific user over a date range:
  • Total viewed, clicked, and interacted counts.
  • Last engagement timestamp.
This is useful for building user-level health scores, identifying disengaged users, or powering re-engagement logic in your backend.

Filtering

All analytics queries support:
  • Date range. Specify startDate and endDate to scope the window.
  • Period. Choose hourly or daily granularity for time-series data.

Multi-device deduplication

When a user receives or interacts with a notification on multiple devices, the same event is deduplicated and counted once. For example, if a push notification is delivered to both a phone and a tablet, it counts as a single delivery in the analytics.

Where to access

  • Dashboard. Navigate to Campaigns > Analytics for visual charts and drill-downs.
  • API. Programmatic access to the same data via the analytics endpoints is part of the admin API surface (rolling out separately). For now, use the Dashboard for visual reports.