Click URL events

Get paginated individual click events for one tracked click URL (across both email and SMS requests), with per-event metadata and the associated customer/recipient data.

Auth: Account — authentication bearer token. The endpoint scopes the click URL via its parent campaign, so only click URLs belonging to the caller's own company are reachable. Otherwise 404 Click URL not found (the example id 9999 is a not-found probe).

Rate limit: No rate limit.

Request

  • Path: click_url_id (integer, required) — click-URL id (route-constrained to [0-9]+).
  • Query: start_date (string Y-m-d, optional) — event window start; defaults to the click URL's 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.
  • Query: page (integer, optional, min 1) — page number.
  • Query: limit (integer, optional, 10–100) — page size; defaults to 20 (values below 10 are raised to 10, capped at 100).

Response{ data. } envelope (double-wrapped as { data: { status, data: {.} } }). data is a hand-built pagination object (only event = 'click' events in window, newest first):

  • current_page (int), per_page (int), total (int), last_page (int).
  • click_url (object) — { id, name, placeholder, url, channel_type }.
  • events (array) — each event: id (int), event (string, always click), ip (string), user_agent (string), referer (string), metadata (object, nullable), created_at (ISO-8601). When the event links an email request, customer_data = { id, email, status, sent_at (ISO/nullable), customer_name, requestor_name }. When it links an SMS request, customer_data = { id, phone_number, status, sent_at, customer_name, requestor_name }; customer_data is absent when neither relation is present.

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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