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 (string Y-m-d, optional) — click-event window start; defaults to campaign created_at start-of-day.
  • Query: end_date (string Y-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.Google is remapped to Google, 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 a landing_page_id exists 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

ParameterTypeRequiredNotes
campaignIdintegerRequiredDigits only.

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json