Create click
Creates a single click transaction via the API. Returns a click_id (UUID) that can be used to attribute conversions.
Authorizations
Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.
Body
Affiliate ID.
Offer ID.
Visitor IP address. Both IPv4 and IPv6 are accepted, e.g. 203.0.113.77 or 2001:db8:85a3::8a2e:370:7334. The value is normalised rather than kept verbatim: an ::ffff: prefix is stripped on input, IPv4 is held in IPv6-mapped form, and IPv6 is stored in ClickHouse binary IPv6, so an uppercase or fully expanded address comes back canonical and lowercase. An unparseable value is silently stored as :: with a 200. A truncated copy such as 203.0.xxx.xxx is stored alongside regardless of settings, and while the platform GDPR hide-IP setting is on the full address is replaced with :: and the reporting endpoints return that truncated mask instead. Used for geo-attribution.
Ignored on input - resolved from the offer.
Ignored on input - the CPC goal is resolved from the offer.
Landing page (offer URL) id. When omitted and creative_id is set, the landing page of that creative is used; otherwise the offer default applies.
Affiliate traffic source id; validated against the affiliate's own sources.
Creative id; validated against the offer's creatives.
Commission plan id. Honoured only when the plan is active, assigned to this affiliate and belongs to this offer; otherwise the plan is auto-selected with no error - first an active plan of this offer assigned to this affiliate, then any active plan of this offer, and if the offer has none, the lowest-id active plan on the platform, which may belong to a different offer. The selected plan is written to the click along with commission_type and traffic_source_id. Forced to 0 on industries that do not use commission plans.
Client user agent; parsed for device, OS and browser detection.
HTTP referrer URL.
Not stored on the click - the click country always comes from the ip lookup. A supplied value is only used for the CPC commission lookup, so sending one can price the click for a country the click itself does not carry.
Ignored on input - not listed in the model rules, so it is dropped before the click is built.
Affiliate sub id 1, stored on the click and available in reports.
Affiliate sub id 2, stored on the click and available in reports.
Affiliate sub id 3, stored on the click and available in reports.
Affiliate sub id 4, stored on the click and available in reports.
Affiliate sub id 5, stored on the click and available in reports.
Affiliate custom parameter 1, stored on the click.
Affiliate custom parameter 2, stored on the click.
Affiliate custom parameter 3, stored on the click.
Affiliate custom parameter 4, stored on the click.
Affiliate custom parameter 5, stored on the click.
Affiliate's own click identifier.
Deep link value stored on the click.
iOS device identifier.
Android device identifier.
Click timestamp (defaults to now).
MD5 click hash for uniqueness validation (32 hex chars).
Custom tracking value 1, stored on the click.
Custom tracking value 2, stored on the click.
Custom tracking value 3, stored on the click.
Custom tracking value 4, stored on the click.
Custom tracking value 5, stored on the click.
Custom tracking value 6, stored on the click.
Custom tracking value 7, stored on the click.
Custom tracking value 8, stored on the click.
Custom tracking value 9, stored on the click.
Custom tracking value 10, stored on the click.