Affilae API Reference (v3.12.0)

Overview

All public routes are detailed on this page.
Our API is under development and breaking changes may happen on public endpoints. In that case a new API version will be deployed.
Our API returns JSON-encoded response and uses standard HTTP response codes.
Affilae API is available for Advertisers and Publishers.

Authentication

You must send a Token in the Authorization Header when making requests.
Your Token is available from the API Tokens menu. Your Token is a sensitive credentials.
curl --header 'Authorization: Bearer {YOUR_TOKEN}' https://rest.affilae.com/

Notes

  • All monetary amounts are sent/returned in cents, i.e. 100 equals to 1.00.
  • No Sandbox is provided yet.
  • API IDs are represented as a 24 character hex string e.g. 5e2f79800000000000000000.
  • Datetime values sent must be in UTC (YYYY-MM-DDTHH:mm:ss.sssZ) and are returned in UTC.

advertiser

Ads information

query Parameters
id
required
string

Ad ID

program
required
string

Program ID

affiliateProfile
required
string

Affiliate Profile ID

Responses

Ads list

query Parameters
program
required
string
Default: "EXAMPLE"

Program ID

type
string
Enum: "image" "text" "email" "coupon" "other"
status
string
Enum: "active" "inactive"
affiliateProfile
string

Affiliate Profile ID

search
string

Responses

Advertiser Information

Responses

Cappings list

query Parameters
program
required
string

Program ID

Responses

Clicks list

query Parameters
orderBy
string
Default: "createdAt"
Value: "createdAt"
sort
string
Default: "desc"
Enum: "asc" "desc"
limit
number <= 1000
Default: 20
offset
number
Default: 0
program
required
string

Program ID

from
string <date>
to
string <date>
partnership
string

Partnership ID

affiliateProfile
string

Affiliate Profile ID

capped
boolean

Responses

Conversion info

query Parameters
program
required
string

Program ID

externalId
string
customerId
string

Responses

Conversions list

query Parameters
orderBy
string
Default: "createdAt"
Enum: "externalId" "createdAt" "amount" "commissions"
sort
string
Default: "desc"
Enum: "asc" "desc"
limit
number <= 1000
Default: 20
offset
number
Default: 0
from
string <date>
to
string <date>
program
string

Program ID

rule
string

Rule ID

partnership
string

Partnership ID

ad
string

Ad ID

status
string
Enum: "pending" "refused" "accepted"
locked
boolean
externalId
string
customerId
string
payment
string
subId
string
contributionSubId
string
capped
boolean

Responses

Partnerships KPIs

query Parameters
programs
Array of strings

Program ID(s)

from
required
string <date>

YYYY-MM-DDTHH:mm:ss.sssZ

to
required
string <date>

YYYY-MM-DDTHH:mm:ss.sssZ

metric
required
string
Enum: "impressions" "clicks" "conversionsCPL" "conversionsCPA" "conversionsTotal" "commissionsTotal" "commissionsCPC" "revenue"
currency
string
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYR" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MUR" "MVR" "MWK" "MXN" "MXV" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STD" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYI" "UYU" "UZS" "VEF" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XBA" "XBB" "XBC" "XBD" "XBT" "XCD" "XDR" "XFU" "XOF" "XPD" "XPF" "XPT" "XTS" "XXX" "YER" "ZAR" "ZMW"

Responses

Partnerships list

query Parameters
orderBy
string
Default: "createdAt"
Enum: "createdAt" "name"
sort
string
Default: "desc"
Enum: "asc" "desc"
program
string

Program ID

groups
Array of strings

Group ID(s)

name
string
affiliateProfiles
Array of strings

Partnership ID

status
Array of strings
Items Enum: "pending" "approved" "cancelled_advertiser" "cancelled_publisher" "blocked" "inactive"
types