get
https://production-api.shoutaboutus.com/api/v1/campaign//report/sms/click-urls
Get SMS click-URL statistics for a campaign — one row per campaign_click_urls (channel sms) with click count, distinct-IP count, and last-clicked timestamp over the date window.
Auth: Account — authentication bearer token; requires the user's own company bundle_id === 3 (ACCOUNT). (404 Campaign not found otherwise). Non-account users get 403.
Rate limit: No rate limit.
Request
- Query:
start_date(stringY-m-d, optional) — defaults to campaigncreated_atstart-of-day. - Query:
end_date(stringY-m-d, optional) — defaults to now end-of-day. Ifstart_date > end_datethe two are swapped.
Response — { data. } envelope. The controller passes an array containing status and data to successResponse, so the literal payload is { data: { status: "success", data: [.rows ] } }.
data.status(string) —"success".data.data[](array) — per click-URL row:id(int) —campaign_click_urls.id.url_name(string) — the URL'sname.placeholder(string) — template placeholder token.destination_url(string) —campaign_click_urls.url; if empty and alanding_page_idexists, synthesized as{white_url}/lp/{landing_page_id}?store_id={store_id}&preview=true.click_count(int) — count ofcampaign_click_eventswithevent = 'click', non-nullsms_request_id, in window.unique_ips(int) — distinctipcount over those events.last_clicked(string ISO-8601 or null) — max eventcreated_at. Rows sorted byclick_countdesc.
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…
