Get Campaign Visitors
GET /analytics/campaign-visitors
Campaign Visitors report for the authenticated org (analytics report a23).
Returns, for the resolved window:
- summary — KPI tiles (page events, campaign clicks, unique contacts / steps, identified visitors, and the encrypted/plaintext/unparseable diagnostic split). Click counters are email-security-scanner filtered (humans only) so they match the in-app report — raw scanner traffic (Microsoft Defender / SafeLinks) is excluded.
- top_campaign_steps — per sequencer step: clicks, unique contacts, a human-readable label, and send-side context (emails sent / with link).
- link_engagement — per clicked destination URL: human clicks, unique contacts, the emails-with-link denominator, and CTR% (clamped 0–100).
- top_contacts — who clicked, with resolved name/email (PII; omit via
include_contacts=false).
Enrichment (labels, email, send counts, CTR) is best-effort: a field is
null when it couldn’t be resolved, never a fabricated zero. An org with
no visitor-tracking pipeline returns an empty report with
summary.jitsu_wired = false.
Agency keys: pass X-Target-Org-Id to run the report for a specific client
org within your authorized set.
Authorizations
Parameters
Query Parameters
Row cap for the steps + contacts tables
Row cap for the steps + contacts tables
Include the Top contacts table (contact name + email — PII). Set false to omit it entirely for a privacy-lean response.
Include the Top contacts table (contact name + email — PII). Set false to omit it entirely for a privacy-lean response.
Header Parameters
Responses
200
Successful Response
object
Composite Campaign Visitors report for a single org (analytics report a23).
object
One row of the Email Link Engagement table (a clicked destination URL).
object
Human click events on this URL (scanner-filtered)
Clicked destination host
Clicked destination path
Sequencer steps whose links drove these clicks
Distinct contacts who clicked this URL
KPI tiles for the org’s campaign-click activity in the window.
All click-derived counters are email-security-scanner filtered (humans only)
when SEQUENCER_VISITOR_SCANNER_FILTER=enforce — the same honest counts the
in-app report shows. total_page_events is all page volume (not filtered).
object
Total (contact, step) click groups before the limit cap
Diagnostic: campaign clicks with an encrypted (#c=e1.) hash
Distinct identified web sessions on campaign clicks
False when the org has no visitor-tracking pipeline / no page events
Total distinct clicked (host, path) before the ceiling
Parseable campaign-attributed click events
Diagnostic: campaign clicks with a plaintext hash
Total distinct campaign steps before the limit cap
All page events in the window (campaign + non-campaign)
Distinct sequencer steps that drew clicks
Distinct contacts who clicked a campaign link
Campaign clicks whose tracking hash could not be decoded
One row of the Top campaign steps table.
object
Campaign click events attributed to this step
Sequencer step id (globally-unique CUID)
Distinct contacts who clicked from this step
One row of the Top contacts table.
Carries PII (name / email) for the org’s own contacts. Omitted
entirely from the response when the request passes include_contacts=false.
object
Per-org contact id
Click events by this contact in the window
The resolved reporting window echoed back to the caller.
object
Inclusive calendar-day span of the window
Window end (inclusive), YYYY-MM-DD
‘anchored’ (explicit start/end) or ‘rolling’ (last-N-days)
Window start (inclusive), YYYY-MM-DD
422
Validation Error