Affilae API Reference (v3.20.0)
Support: support@affilae.com URL: https://affilae.com
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
- API endpoint: https://rest.affilae.com
- API IDs are represented as a 24 character hex string e.g.
5e2f79800000000000000000. - API IDs (e.g. program ID / profile ID / user ID) can be retrieved from `*.me` (e.g. https://rest.affilae.com/advertiser/advertisers.me or https://rest.affilae.com/publisher/publishers.me) or `*.list` routes
- All monetary amounts are sent/returned in cents, i.e.
100equals to1.00. - Datetime values sent must be in UTC (YYYY-MM-DDTHH:mm:ss.sssZ) and are returned in UTC.
- No Sandbox is provided yet.
- Endpoints are subject to rate limit (100 req/s) and may return a 429 status code (Too Many Requests).
Rate Limit Headers
| Header | Description |
|---|---|
| x-ae-ratelimit-route-second-limit | Maximum number of requests per duration (e.g. 100) |
| x-ae-ratelimit-route-second-reset | Duration in seconds (e.g. 1) |
| x-ae-ratelimit-route-second-remaining | Number of requests remaining for the current duration (e.g. 42) |
| x-ae-ratelimit-route-second-consumed | Number of requests already used for the current duration (e.g. 58) |
| x-ae-ratelimit-route-second-retry-after | Number of seconds to wait before retrying after a rate-limiter failure (e.g. 0) |
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
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" "commissionsAvg" "EPC" "revenue" |
| status | string Enum: "pending" "refused" "accepted" Accepted and Pending by default |
| 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" |