Choose a task
Retrieve visitor data
List identified visitors, retrieve a journey, and understand canonical visitor fields.
Retrieve session summaries
Page through stable, privacy-bounded session facts without receiving detailed events.
Query qualified visitors
Use a saved segment or canonical rule to return only visitors who qualify.
Manage pixels
Create, list, pause, activate, and configure tracking pixels.
Suppress unwanted traffic
Prevent selected visitors from consuming credits or triggering automations.
Check account status
Review organization health, credits, pixels, and intent access.
Base URL
Authentication
All requests require anX-API-Key header with your organization API key.
Data API
Use the Data API to list identified visitors, retrieve one visitor journey, page through privacy-bounded session summaries, or query only visitors that match qualification rules. Read the Data API guide for canonical visitor fields, custom pixel attribution, qualification examples, pagination, rate limits, and legacy aliases.Pixel API
The pixel endpoints let you:- list all pixels for your organization
- create a pixel and receive the embed
codesnippet - pause or activate a pixel
- manage path filters with
includedPathsorexcludedPaths
includedPaths: allowlist mode, where the pixel fires only on matching path prefixesexcludedPaths: denylist mode, where the pixel fires everywhere except matching path prefixes
pausedReasonwhen listing pixelscodewhen creating a pixel
Visitor suppression
The suppression endpoints let you exclude traffic from credits and automations byemail, domain, company_domain, or industry. Suppressed visitors are still identified, but they consume no credits and trigger no webhooks or integrations.
Read Visitor suppression before your first upload. Industry rules match the enriched company industry exactly, so start from the industries endpoint rather than guessing values.
These endpoints are rate limited to 30 requests per minute per IP, lower than the rest of /v1/data.