Skip to navigation

Add click

View as Markdown

Track a landing page visit. Returns a SessionID to pass on subsequent page calls and in the Add Customer call for funnel attribution.

Authentication

Authorizationstring

Format: ApiKey <your_key>

Headers

Idempotency-KeystringRequiredformat: "uuid"
UUID to prevent duplicate POST operations

Request

This endpoint expects an object.
PageTypeenumRequired
SessionIDstring or nullOptional

SessionID from a previous Add Click call (to track subsequent pages)

SiteIDintegerOptional
Required if SessionID is null
RequestUristringOptional
Full landing page URL including query params. Required if SessionID is null
IpAddressstringOptional

Customer IP (IPv4 or IPv6). Required if SessionID is null

AffiliateIDstringOptional
UserClickIDstringOptional
External click ID for tracking

Response

Click tracked
StatusintegerOptional
GoodbooleanOptional
ResultobjectOptional