Outbound

Get the Outbound analytics summary

Returns aggregate engagement for a message, matching the tiles on the dashboard analytics tab.

GET

/v2/outbound/messages/{outboundMessageId}/analytics/summary

curl --request GET \
  --url https://do.featurebase.app/v2/outbound/messages/{outboundMessageId}/analytics/summary \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-09-03.pulsar'

{
  "deliverySummary": {
    "opened": 75,
    "sent": 120
  },
  "metrics": [
    "sent"
  ],
  "object": "outbound_analytics_summary",
  "summary": {
    "opened": 80,
    "sent": 120
  },
  "uniqueSummary": {
    "opened": 70,
    "sent": 110
  }
}

Response

summary - Event totals keyed by metric
uniqueSummary - Unique users keyed by metric
deliverySummary - Unique deliveries keyed by metric
metrics - Metrics collected for this message type, in display order

Metrics depend on the channel. Emails report sent, delivered, opened, clicked, bounced and unsubscribed; chats and banners report sent, opened, clicked, dismissed and replied; surveys report sent, opened, answered and completed. Counts are approximate and deduplicated.

Errors

400 - Invalid message ID format
404 - Message not found or doesn't belong to your organization
502 / 504 - The analytics store failed or timed out; retry later

Version Availability

This endpoint is only available in API version 2026-09-03.pulsar and newer.

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

outboundMessageIdstringrequired

Outbound message ID

Example: 6457e3ff70afca5d8c27dccc

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

Success

deliverySummaryobjectrequired

Approximate unique delivery counts keyed by metric

metricsenum<string>[]required

Metrics collected for this message type, in display order

objectenum<string>required

Object type identifier

Available options: outbound_analytics_summary

Example: outbound_analytics_summary

summaryobjectrequired

Approximate event totals keyed by metric

uniqueSummaryobjectrequired

Approximate unique user counts keyed by metric

Still need help? Ask the team