Analytics

Get 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.

get/analytics/campaign-visitors

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/analytics/campaign-visitors
  • Auth: HTTP bearer

Query parameters

start_datestring date nullable

Window start (inclusive), YYYY-MM-DD. If omitted, derived from days.

end_datestring date nullable

Window end (inclusive), YYYY-MM-DD. If omitted, today.

daysinteger nullable

Rolling 'last N days from today'. Ignored when start_date/end_date are supplied.

limitinteger

Row cap for the steps + contacts tables

include_contactsboolean

Include the Top contacts table (contact name + email — PII). Set false to omit it entirely for a privacy-lean response.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

Changes

No recorded changes to this operation across all 2 revisions of this API.