Tracking & Identification

Endpoints

Track Events

POST /api/visitors/track

Records visitor events such as pageviews, clicks, custom events, and purchases.

Request Body:

• event_type (string, required): The type of event (e.g., ‘pageview’, ‘click’, ‘custom’, ‘purchase’).
• site_id (string, UUID, required): The ID of the site.
• visitor_id (string, UUID, required): The ID of the visitor.
• url (string, URL, required): The current URL.
• properties (object, optional): Event-specific properties.

Identify Visitor

POST /api/visitors/identify

Links anonymous visitors with known identification information (lead ID, email, etc.).

Request Body:

• site_id (string, UUID, required): The ID of the site.
• id (string, UUID, required): The visitor ID.
• lead_id (string, UUID, optional): The lead ID if known.
• traits (object, optional): Visitor traits (email, name, phone, company, etc.).

Note: Requires lead_id OR traits with at least one identifier (email, phone).

Segment Visitor

POST /api/visitors/segment

Manages visitor segmentation and assigns segments, campaigns, or experiments to visitors.

Request Body:

• site_id (string, UUID, required): The ID of the site.
• visitor_id (string, UUID, required): The visitor ID.
• url (string, URL, required): The current URL.
• segment_id (string, optional): The segment ID.
• campaign_id (string, optional): The campaign ID.
• experiment_id (string, optional): The experiment ID.