Skip to main content

Offer

An offer

Fields

FieldTypeAvailabilityNotes
idIDThe record's Refersion id.
typeString
commissionStringThe commission the offer pays, as a decimal string. Read together with type.
flat_rate_currencyStringISO 4217 currency of commission when type is a flat rate.
cookie_daysStringHow many days a click stays eligible for attribution.
commission_termsStringThe commission terms shown to affiliates.
business_categoryString
unified_paymentsBoolean
shopShop
affiliates[Affiliate]Takes arguments — see below.
conversions[Conversion]Takes arguments — see below.
clicks[Click]Takes arguments — see below.
nameStringMerchant tokens only

Sorting

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

Field arguments

affiliates

ArgumentTypeNotes
idIDReturns only the record with this id.
statusStringExact match. The returned type lists the values that can appear.
emailStringExact match on the affiliate's email address.
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.
last_login_fromIntUnix timestamp in seconds. Exclusive.
last_login_toIntUnix timestamp in seconds. Inclusive.
last_conversion_fromIntUnix timestamp in seconds. Exclusive.
last_conversion_toIntUnix timestamp in seconds. Inclusive.
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.

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.
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.

clicks

ArgumentTypeNotes
idIDReturns only the record with this id.
sub_idIDMatches the subid carried on the tracking link.
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.
affiliate_idIDReturns only records belonging to this affiliate.
creative_idIDReturns only records tied to this creative.
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