get
https://production-api.shoutaboutus.com/api/v1/campaign//report/email/click-urls
Get per-URL click statistics for the email channel of a campaign. Which tracked click URLs were clicked, how many times, by how many distinct IPs, and when last clicked.
Auth: Account — authentication bearer token. Non-matching id returns 404 Campaign not found.
Rate limit: No rate limit.
Request
- Query:
start_date(stringY-m-d, optional) — click-event window start; defaults to campaigncreated_atstart-of-day. - Query:
end_date(stringY-m-d, optional) — window end; defaults to now end-of-day. Swapped if start > end.
Response — { data. } envelope (double-wrapped as { data: { status, data: [.] } }). data is an array of CampaignClickUrl rows (channel_type = 'email'), ordered by click_count desc, each LEFT-joined to campaign_click_events (event=click, email events only, in window):
id(int) — click-URL id.url_name(string) — display name;Maps.Googleis remapped toGoogle, and(Follow-up)is appended when the URL is a follow-up link.is_follow_up(bool).placeholder(string) — template placeholder token.destination_url(string) — target URL; when empty but alanding_page_idexists it is built from the white-label URL as{white_url}/lp/{landing_page_id}?store_id={store_id}&preview=true.click_count(int) — total click events in the window.unique_ips(int) — distinct IPs.last_clicked(ISO-8601 datetime, nullable) — max event time, or null if never clicked.
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…
