Email delivered comparison

Overview

Get delivered-count comparison between Email and SMS for a campaign, bucketed by day, week, or month.

Prerequisites

• A bearer token. Callable with Account tokens.
• The campaignId of the record you are targeting.

Base URL

Endpoint

GET /api/v1/campaign/{campaignId}/report/delivered-comparison

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Who can call it: Account tokens.

• A non-matching id returns 404 Campaign not found.

Rate limit

• No rate limit.

Path parameters

Query parameters

• Query: group_by (string, optional) — day, week, or month; defaults to day. day buckets are Y-m-d-labelled, week buckets are Mon–Sun ranges labelled like Aug 18-24, 2025, month buckets are labelled like Aug 2025.
• Query: limit (integer, optional, 1–7) — number of buckets ending at end_date; defaults to 7.
• Query: end_date (string Y-m-d, optional) — anchor for the most recent bucket; defaults to now end-of-day.

Response

• data.data[].key (string) — the bucket label (date / week-range / month, per group_by).
• data.data[].email (int) — non-test rows delivered (delivered_at) in the bucket.
• data.data[].sms (int) — non-test rows delivered in the bucket.

200 Success · 200

{ "data": { "status": "success", "data": [
  { "key": "2026-06-20", "email": 42, "sms": 37 },
  { "key": "2026-06-21", "email": 50, "sms": 31 }
] } }

Errors

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/campaign/123/report/delivered-comparison" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'