Skip to main content

Affiliate

Affiliates of clients

Fields

FieldTypeAvailabilityNotes
idInt!The record's Refersion id.
statusStringOne of ACTIVE, PENDING, DISABLED, DENIED. Affiliates in any other state are never returned, whatever you filter on.
createdStringUnix timestamp in seconds, not an ISO 8601 date. null when the underlying date is unset.
updatedStringUnix timestamp in seconds, not an ISO 8601 date. null when the underlying date is unset.
last_loginStringUnix timestamp in seconds, not an ISO 8601 date. null when the underlying date is unset.
last_conversionStringUnix timestamp in seconds, not an ISO 8601 date. null when the underlying date is unset.
first_nameString
last_nameString
companyString
emailString
paypal_emailString
address1String
address2String
cityString
stateString
zipString
countryString
registered_ipString
phone_numberString
unique_merchant_idStringYour own identifier for the affiliate, if you set one.
custom_fields[[String]]The affiliate's answers to your custom registration fields, as a list of [id, label, value] triples. Empty when the affiliate has none.
nameStringConvenience field: first_name and last_name joined with a space.
addressStringConvenience field: the address lines, city, state and country joined into one string.
rfsn_parameterStringThe tracking fragment to append to a destination URL for this affiliate, for example &rfsn=123456.1234c.
registration_sourceStringHow the affiliate joined your program.
shopShop
clicks[Click]Takes arguments — see below.
conversions[Conversion]Takes arguments — see below.
conversion_triggers[ConversionTrigger]Takes arguments — see below.
offerOffer
payments[Payment]Takes arguments — see below.

Sorting

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

Field arguments

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.
creative_idIDReturns only records tied to this creative.
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.

conversions

ArgumentTypeNotes
idIDReturns only the record with this id.
statusStringExact match. The returned type lists the values that can appear.
payment_statusStringPass UNPAID for records not yet in a payment. Any other value matches records that are already in one.
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.
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.

conversion_triggers

ArgumentTypeNotes
idStringReturns only the record with this id.
statusStringExact match. The returned type lists the values that can appear.
triggerStringExact match on the trigger value — the coupon code, email address, or SKU.
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.
updated_fromIntUnix timestamp in seconds. Exclusive — matches rows updated strictly after it.
updated_toIntUnix timestamp in seconds. Inclusive — matches rows updated at or before it.
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.

payments

ArgumentTypeNotes
idIDReturns only the record with this id.
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.
commission_totalStringExact match on the stored value. This is not a range filter.
totalStringExact match on the stored value. This is not a range filter.
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