get
https://production-api.shoutaboutus.com/api/v1/campaign//report/email
Get email-channel KPIs (recipients, sent, delivered, opened, clicked, unsubscribed, failed, processed, tests/kiosk counts plus derived rates) and a fixed last-7-day daily timeseries for a single campaign.
Auth: Account — authentication bearer token. The campaign, so a user can only read reports for campaigns owned by their own company (the account/location account). A non-matching id returns 404 Campaign not found.
Rate limit: No rate limit.
Request
- Query:
start_date(stringY-m-d, optional) — KPI window start; defaults to the campaign'screated_atstart-of-day. - Query:
end_date(stringY-m-d, optional) — KPI window end; defaults to now end-of-day. Ifstart_date > end_datethe two are swapped. Note: thetimeseries.by_dayblock always covers the last 7 days (now-6 → end) regardless of the date filter.
Response — { data. } envelope. The controller returns its own status/data keys which are then wrapped again by successResponse, so the payload is { data: { status, data: { kpis, timeseries } } }.
kpis.recipients_valid(int) — count ofCampaignAudienceDatawithis_email_valid = 'valid', non-test.kpis.sent/delivered/opened/clicked/unsubscribed(int) — counts of non-test rows whose respective*_attimestamp falls in the window.kpis.failed(int) — rows withstatus = 'failed'within the window (failed_at).kpis.processed(int) — non-test rows created in the window.kpis.tests_sent(int) —is_test = truerows created in the window.kpis.kiosk_sent(int) — non-testis_kiosk = truerows created in the window.kpis.rates(object) —processed_rate,delivery_rate,open_rate,click_rate,unsubscribe_rate,sent_vs_audience_rate(floats, percent rounded to 2dp; 0 when denominator is 0).timeseries.by_day(array) — one entry per day for the last 7 days, each{ date (Y-m-d), sent, delivered, opened, clicked, unsubscribed, failed, processed }(ints).
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…
