Outbound

Get the Outbound analytics time series

Returns engagement over time for a message, bucketed by hour, day or week.

GET

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

curl --request GET \
  --url 'https://do.featurebase.app/v2/outbound/messages/{outboundMessageId}/analytics/timeseries?start=%3Cstring%3E&end=%3Cstring%3E&bucket=hour&timezone=%3Cstring%3E&metrics=%3Cstring%3E' \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-09-03.pulsar'

{
  "bucket": "day",
  "end": "2026-09-01T00:00:00.000Z",
  "object": "outbound_analytics_timeseries",
  "series": [
    {
      "event": "sent",
      "points": [
        {
          "date": "2026-08-01T00:00:00.000Z",
          "totalCount": 12,
          "uniqueCount": 10
        }
      ]
    }
  ],
  "start": "2026-08-01T00:00:00.000Z",
  "timezone": "Europe/Tallinn"
}

Query Parameters

start - Range start (ISO 8601, required)
end - Range end (ISO 8601, required, exclusive)
bucket - hour, day or week (required)
timezone - IANA timezone for bucket boundaries (defaults to the organization timezone)
metrics - Comma-separated metrics to include (defaults to every metric of the message type)

The range is limited per bucket size, for example a maximum of 31 days for hourly buckets. Buckets without events are zero-filled.

Response

Returns one series per metric. Each point has date, totalCount and uniqueCount.

Errors

400 - Invalid message ID, range, bucket, timezone or metrics filter
404 - Message not found or doesn't belong to your organization
502 / 504 - The analytics store failed or timed out; narrow the range and retry

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

Query Parameters

startstring | nullquery

endstring | nullquery

bucketenum<string>queryrequired

Available options: hour, day, week

timezonestringquery

Maximum string length: 100

metricsstringquery

Maximum string length: 500

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

bucketenum<string>required

Bucket size

Available options: hour, day, week

Example: day

endstringrequired

Range end as an ISO 8601 timestamp (exclusive)

Example: 2026-09-01T00:00:00.000Z

objectenum<string>required

Object type identifier

Available options: outbound_analytics_timeseries

Example: outbound_analytics_timeseries

seriesobject[]required

One zero-filled series per metric

Show child attributes

startstringrequired

Range start as an ISO 8601 timestamp

Example: 2026-08-01T00:00:00.000Z

timezonestringrequired

IANA timezone used for bucket boundaries

Example: Europe/Tallinn

Still need help? Ask the team