get
https://production-api.shoutaboutus.com/api/v1/campaign//report/delivered-comparison
Get delivered-count comparison between Email and SMS for a campaign, bucketed by day, week, or month.
Auth: Account — authentication bearer token. Non-matching id returns 404 Campaign not found.
Rate limit: No rate limit.
Request
- Query:
group_by(string, optional) —day,week, ormonth; defaults today.daybuckets areY-m-d-labelled,weekbuckets are Mon–Sun ranges labelled likeAug 18-24, 2025,monthbuckets are labelled likeAug 2025. - Query:
limit(integer, optional, 1–7) — number of buckets ending atend_date; defaults to 7. - Query:
end_date(stringY-m-d, optional) — anchor for the most recent bucket; defaults to now end-of-day.
Response — { data. } envelope (double-wrapped as { data: { status, data: [.] } }). data is an ordered array of buckets:
key(string) — the bucket label (date / week-range / month, pergroup_by).email(int) — non-test rows delivered (delivered_at) in the bucket.sms(int) — non-test rows delivered in the bucket.
Path params
| Parameter | Type | Required | Notes |
|---|---|---|---|
campaignId | integer | Required | Digits only. |
Errors: 422 on validation failure.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
