Skip to main content

Click

An affiliate's click

The Click type does not expose an id field, even though clicks(id: …) accepts one as a filter. Use before and after to page through clicks.

Fields

FieldTypeAvailabilityNotes
sub_idStringThe subid value carried on the tracking link, if the affiliate set one.
createdStringUnix timestamp in seconds, not an ISO 8601 date. Sourced from the click's entry time.
refererStringThe page the shopper came from, as reported by the browser.
landed_urlStringThe URL the shopper landed on after following the link.
affiliate_idInt!The affiliate the record belongs to.
creative_idIntThe creative the click came from.
affiliatesAffiliate
shopShop
offerOffer
creativeCreative
conversions[Conversion]Takes arguments — see below.

Sorting

sort accepts id, created, subid on this type, and sorts descending. Any other value is ignored without an error.

Field arguments

conversions

ArgumentTypeNotes
idIDReturns only the record with this id.
statusStringExact match. The returned type lists the values that can appear.
typeStringExact match. The returned type lists the values that can appear.
created_fromIntUnix timestamp in seconds. Exclusive — matches rows created strictly after it.
created_toIntUnix timestamp in seconds. Inclusive — matches rows created at or before it.
payment_statusStringPass UNPAID for records not yet in a payment. Any other value matches records that are already in one.
affiliate_idIDReturns only records belonging to this affiliate.
offer_idIDReturns only records tied to this offer.
sortStringField to sort by, descending. Each type accepts its own short list — see Sorting on the returned type's page. Anything else is ignored without an error.
limitIntRows to return. Anything outside 1–200 is replaced by 200.
beforeIDReturns only rows with an id lower than this. Cursor-style paging.
afterIDReturns only rows with an id higher than this. Cursor-style paging.
offsetIntRows to skip before returning results.

Referenced by