Adtraction API v2
This is the full documentation for the Adtraction API, version 2.
In order to access the API, you need an account with Adtraction. You can pick up your unique API token by logging in to your Adtraction account and navigating to Account > Settings.
The documentation is interactive; calls can be made to all documented endpoints within the browser without the need to write any code.
Certain endpoints have been deprecated. In such cases, please use API version 3 instead.
If you have any questions regarding the API, feel free to contact [email protected].
API url
The base url for all API endpoints is https://api.adtraction.net/v2/
Useful links
General notes
| Encoding | Every string passed to and from the Adtraction API needs to be UTF-8 encoded. |
| SSL | We require that all requests are done over SSL. |
| Date format | The Adtraction tracking server is running on Stockholm time. All dates are in ISO 8601 format expressed as UTC (Coordinated Universal Time). Time zones are represented as an offset from UTC. Example: 2019-07-16T14:45:15+0200 |
Header parameters
| X-Token | Defines the request API token. This will be used to determine privileges and visibility for the request. |
| content-type | Defines the format of data sent to Adtraction. Adtraction accepts JSON. Example: content-type: application/json |
| accept | Defines the format of data received from Adtraction. Adtraction supports JSON. Example: accept: application/json |
Pagination
Certain endpoints will generate large result sets. To save bandwidth and long processing times, these endpoints will paginate the results to reduce the strain on both client and server.
Any endpoint that supports pagination will return 3 attributes to support this:
-
count- the total number of results available -
pageSize- the number of results per page to return -
page- the number of the page to return. The first page in the response is number 0.
Rate limiting
The API endpoints are rate limited by a quota per minute.
On each request the remaining quota is decreased. If the remaining quota is less than zero, the status code 429 will be returned with a message containing the time remaining until reset.
Each endpoint response includes header parameters with information about its limit, remaining requests and reset time. Example:
Status: 200 OK
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1561967218095
| Header name | Description |
|---|---|
| X-RateLimit-Limit | The maximum number of requests you’re permitted to make per minute. |
| X-RateLimit-Remaining | The number of requests remaining in the current rate limit window. |
| X-RateLimit-Reset | The time at which the current rate limit window resets in UTC epoch seconds. |
Response codes and statuses
| Code | Status | Description |
|---|---|---|
| 200 | OK | The request has succeeded. |
| 201 | Created | The request has been fulfilled and resulted in a new resource being created. |
| 204 | No content | The server successfully processed the request, but is not returning any content. |
| 400 | Bad request | The request could not be understood by the server due to malformed syntax. |
| 401 | Unauthorized | The request requires user authentication. |
| 403 | Forbidden | The server understood the request, but user is not authorized to perform the operation. |
| 404 | Not found | The server has not found anything matching the Request-URI. |
| 409 | Conflict | The request could not be completed due to a conflict with the current state of the resource. |
| 415 | Unsupported media type | The request entity has a media type which the server or resource does not support. |
| 429 | Too many requests | Your are making too many requests and are being rate limited. |
| 500 | Internal server error | The server encountered an unexpected condition which prevented it from fulfilling the request. |
Partner ¶
Markets ¶
Adtraction offers partner programs on several geographical markets.
List marketsGET/partner/markets/{?token}
Lists the markets on which Adtraction offers partner programs.
Example URI
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"market": "SE",
"marketName": "Sweden",
"marketId": 12
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Channels ¶
A channel is where a partner places banners or links to earn commission. It can be a website, a blog or a newsletter. It may also be paid advertising on, for example, Adwords or Facebook.
You can have as many channels as you want in your Adtraction account.
List approved channelsGET/partner/channels/{channelId}/{?token}
Lists all the approved channels in your partner account.
Example URI
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
- channelId
number(optional) Example: 1175982945Numerical ID of a channel
Headers
Content-Type: application/json;charset=UTF-8200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"channelId": 1175982945,
"channelName": "John's business blog",
"channelUrl": "https://www.johnsblog.com",
"channelType": "Blog"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Currencies ¶
List currenciesGET/partner/currencies/{?token}
Lists all active currencies on the Adtraction platform.
Example URI
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: close- currency
string(optional)Currency in ISO 4217 format
- currencyId
number(required)Numerical ID of a currency
Body
{
"currency": "EUR",
"currencyId": 707815392
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "Currency in ISO 4217 format"
},
"currencyId": {
"type": "number",
"description": "Numerical ID of a currency"
}
},
"required": [
"currencyId"
]
}Applications ¶
Channels that are approved in the Adtraction system may apply to partner programs. Each partner program has rules about what kind of advertising is permitted.
List applicationsGET/partner/applications/{?programId,channelId,token}
Lists the status of all your applications to partner programs.
Example URI
- programId
number(optional) Example: 462891022Numerical ID of a partner program
- channelId
number(optional) Example: 49326900Numerical ID of a channel
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"channelId": 49326900,
"channelName": "John's business blog",
"status": 1,
"programId": 462891022,
"programName": "Bubbleroom SE",
"categoryName": "Banking & Finance",
"categoryId": 1
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Programs ¶
Each advertiser with Adtraction has its own partner program, which is a partnership where partners send visitors to the advertiser in exchange for commission. Each partner program has rules about what kind of advertising is permitted and what commission is offered.
Retreive program informationGET/partner/programs/{?market,programId,channelId,approvalStatus,token}
This endpoint is deprecated. Please use API version 3.
Retreives information about partner programs available on the Adtraction platform.
Example URI
- market
string(required) Example: SEGeographical market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code
- programId
number(optional) Example: 629059552Numerical ID of a partner program
- channelId
number(optional) Example: 1175982945Numerical ID of a channel
- approvalStatus
number(optional) Example: 1Approval status for a partner program: 0 = rejected, 1 = approved, 2 = pending review
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"programId": 629059552,
"market": "SE",
"currency": "SEK",
"approvalStatus": 1,
"feed": true,
"ppcMarketing": 1,
"socialMarketing": 1,
"emailMarketing": 1,
"cashbackMarketing": 1,
"couponMarketing": 1,
"programName": "Sportamore SE",
"programURL": "https://www.sportamore.se",
"currentSegment": "Gold",
"pendingActive": false,
"cookieDuration": 45,
"adId": 1062755777,
"commissions": [
{
"id": "1066446216",
"type": "SEK",
"name": "Sale new customer",
"value": 100,
"transactionType": 3
}
],
"feedURL": "Hello, world!",
"logoURL": "https://secure.adtraction.com/image.htm?imgId=56807831",
"trackingURL": "https://track.adtraction.com/t/t?a=24209996&as=24577691&t=2&tk=1",
"categoryName": "Fashion & accessories",
"trackingType": 2
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Program categories ¶
All partner programs on the Adtraction platform belong to a specific category, such as Banking & Finance or Family & Kids.
List program categoriesGET/partner/programs/categories/{marketId}{?token}
Lists all program categories and the number of partner programs currently available in each category.
Example URI
- marketId
number(required) Example: 12Numerical ID of a geographical market
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"categoryName": "Banking & Finance",
"categoryId": 1,
"numberOfPrograms": 34
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Program directory ¶
Retreive program directoryGET/partner/programs/directory/{marketId}/{categoryId}{?token}
List all programs with their associated category.
Example URI
- marketId
number(optional) Example: 12Numerical ID of a geographical market
- categoryId
number(optional) Example: 1Numerical ID of the category
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: close- categoryId
number(optional)Numerical ID of the category
- categoryName
string(optional)Name of the category
- logoUrl
string(optional)URL of the advertiser logo image file
- market
string(optional)Geographical market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code
- programId
number(optional)Numerical ID of the partner program
- programName
string(optional)Name of a partner program
- programUrl
string(optional)Main URL for a partner program
Body
{
"categoryId": 1,
"categoryName": "Banking & Finance",
"logoUrl": "https://adtraction.com/image.htm?imgId=56807831",
"market": "SE",
"programId": 23959067,
"programName": "Ferratum SE",
"programUrl": "https://www.ferratum.se"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"categoryId": {
"type": "number",
"description": "Numerical ID of the category"
},
"categoryName": {
"type": "string",
"description": "Name of the category"
},
"logoUrl": {
"type": "string",
"description": "URL of the advertiser logo image file"
},
"market": {
"type": "string",
"description": "Geographical market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code"
},
"programId": {
"type": "number",
"description": "Numerical ID of the partner program"
},
"programName": {
"type": "string",
"description": "Name of a partner program"
},
"programUrl": {
"type": "string",
"description": "Main URL for a partner program"
}
}
}Commission types ¶
Each partner program on the Adtraction platform offers one or several types of commissions, such as commission for a confirmed purchase or a newsletter signup.
List commission typesGET/partner/programs/commissions/{programId}/{channelId}/{?token}
This endpoint is deprecated. Please use API version 3.
List all the commission types available for a partner program.
Using channelId as input will return the commissions of the segment that the channel currently belongs to. If channelId is not provided, the commissions in the standard segment will be returned.
Example URI
- programId
number(required) Example: 23959067Numerical ID of the partner program
- channelId
number(optional) Example: 101496920Numerical ID of a channel
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"id": "1066446216",
"type": "SEK",
"name": "Sale new customer",
"value": 100,
"transactionType": 3
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}New programs ¶
List new programsGET/partner/programs/new/{marketId}/{?token}
Lists partner programs recently added to the Adtraction platform. Programs are normally classified as new for up to 30 days.
Example URI
- marketId
number(required) Example: 1Numerical ID of a geographical market
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"logoURL": "https://secure.adtraction.com/image.htm?imgId=56807831",
"programName": "Sportamore",
"categoryName": "Fashion & accessories",
"categoryId": 1,
"sortorder": 3,
"createdDate": "2018-10-08T14:53:00+0100",
"programId": 1062755777
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Products ¶
The Adtraction product database holds data such as price, images and links for products sold by advertisers on the Adtraction platform.
Find productsPOST/partner/products/{?token}
Searches the Adtraction product database. Meta data is available in the response header, where count is the total number of products found for the specified search query, maxprice is the highest price found, and minprice is the lowest price found.
If you require tracking links, combine with a call to the /partner/tracking/link/ endpoint.
If you require all products from a certain advertiser, use the /partner/products/productfeed/ endpoint.
The search function is not case sensitive. The following operators can be used in the keyword field to modify your search:
AND signifies AND operation. Search for X and Y. This will return only results related to both X and Y.
OR signifies OR operation. Search for X or Y. This will return results related to X or Y, or both.
- excludes a term or phrase.
" wraps a number of words to signify a phrase for searching.
* at the end of a term signifies a wildcard query.
( and ) signify precedence.
AND discounted:true will include only products where productPrice is lower than oldPrice.
Examples:
Phrase match:
{"keyword": "\"Nivea Shower Creme Care 250 ml\"", "page": 0, "pageSize": 10}
Phrase match with wildcard:
{"keyword": "\"Nivea shower*\"", "page": 0, "pageSize": 10}
Exclude a term:
{"keyword": "Nivea -shower", "page": 0, "pageSize": 10}
AND operation
{"keyword": "Nivea AND shower", "page": 0, "pageSize": 10}
OR operation
{"keyword": "Nivea OR shower", "page": 0, "pageSize": 10}
You can speed up your query significantly by specifying what field to search in the database.
The following fields can be searched individually: productPrice, productUrl, currency, programId, ean, sku, imageUrl, inStock, manufacturer, manufacturerArticleNumber, market, oldPrice, productCategory, productDescription, shipping.
Example:
Search for 1334868914 in the sku field only:
{"keyword": "sku:1334868914", "page": 0, "pageSize": 1}
Search meta data:
Each response includes header parameters with information about the results data set.
| Header name | Description |
|---|---|
| count | The number of products in the results dataset. |
| maxprice | The highest price of all the products in the results dataset. |
| minprice | The highest price of all the products in the results dataset. |
Example URI
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- keyword
string(required)Search keyword. Matches against all output fields.
- page
number(required)The specified result page in the paginated response. The first page in the response is number 0.
- pageSize
number(required)Number of products to return on each page of a paginated result
- programId
string(optional)Numerical ID of one or several partner programs. Comma separated.
- market
string(optional)Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code
- currency
string(optional)Currency in ISO 4217 format
- inStock
boolean(optional)Only return products that are (or are not) in stock
- minPrice
number(optional)Only show products with a price of at least minPrice
- maxPrice
number(optional)Only show products with a price of at most maxPrice
- sort
string(optional)Determines the sort order. The value of this parameter is a comma-separated list of sort keys. Sort directions ‘asc’ or ‘desc’ can optionally be appended to each sort key, separated by the ‘:’ character. Available keys are: productPrice, programId, inStock, manufacturerArticleNumber, ean.
Body
{
"keyword": "macadamia",
"page": 0,
"pageSize": 10,
"programId": "1117786218,462891022",
"market": "SE",
"currency": "SEK",
"inStock": true,
"minPrice": 50,
"maxPrice": 250,
"sort": "programId,productPrice:desc"
}Schema
{
"type": "object",
"properties": {
"keyword": {
"type": "string",
"description": "Search keyword. Matches against all output fields."
},
"page": {
"type": "number",
"description": "The specified result page in the paginated response. The first page in the response is number 0."
},
"pageSize": {
"type": "number",
"description": "Number of products to return on each page of a paginated result"
},
"programId": {
"type": "string",
"description": "Numerical ID of one or several partner programs. Comma separated."
},
"market": {
"type": "string",
"description": "Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code"
},
"currency": {
"type": "string",
"description": "Currency in ISO 4217 format"
},
"inStock": {
"type": "boolean",
"description": "Only return products that are (or are not) in stock"
},
"minPrice": {
"type": "number",
"description": "Only show products with a price of at least minPrice"
},
"maxPrice": {
"type": "number",
"description": "Only show products with a price of at most maxPrice"
},
"sort": {
"type": "string",
"description": "Determines the sort order. The value of this parameter is a comma-separated list of sort keys. Sort directions 'asc' or 'desc' can optionally be appended to each sort key, separated by the ':' character. Available keys are: productPrice, programId, inStock, manufacturerArticleNumber, ean. "
}
},
"required": [
"keyword",
"page",
"pageSize"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
count: 178
page: 0
pageSize: 10
keyword: jeans
maxprice: 2499.0
minprice: 10.0
manufacturers: "Emporio Armani"
productCategories: "apparel & accessories - clothing - underwear & socks - underwear"
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"productName": "PlayStation 4",
"productPrice": "129.5",
"productUrl": "https://www.site.com/store/product_acb",
"currency": "EUR",
"programId": 1062755777,
"ean": "0711719437215",
"sku": "abc123",
"extraInfo": [
{
"key": "color",
"value": "red"
}
],
"imageUrl": "http://www.site.com/store/product_acb.png",
"inStock": true,
"manufacturer": "Sony",
"manufacturerArticleNumber": "12345678",
"market": "SE",
"oldPrice": 45,
"productCategory": "Consoles",
"productDescription": "PlayStation 4 redefines rich and immersive gameplay with powerful graphics and speed.",
"shipping": 9
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Product feed ¶
Retrieve product feedPOST/partner/products/feed/{?token}
This endpoint is deprecated. Please use API version 3.
Retrieves data for all available products for a specified advertiser. Meta data is available in the response header, where count is the number of products available, and feed_lastupdated is the time the advertiser last updated their product feed.
Example URI
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- programId
number(required)Numerical ID of a partner program
- channelId
number(required)Numerical ID of a channel
- setEpi
boolean(optional)If set to true, the epi will be set to the product name in tracking urls
Body
{
"programId": 23959067,
"channelId": 101496920,
"setEpi": true
}Schema
{
"type": "object",
"properties": {
"programId": {
"type": "number",
"description": "Numerical ID of a partner program"
},
"channelId": {
"type": "number",
"description": "Numerical ID of a channel"
},
"setEpi": {
"type": "boolean",
"description": "If set to true, the epi will be set to the product name in tracking urls"
}
},
"required": [
"programId",
"channelId"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
count: 4547
feed_lastupdated: Tue Aug 27 14:56:30 CEST 2019
Content-Type: application/json;charset=UTF-8
Content-Length: 17959940
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"productName": "PlayStation 4",
"productPrice": "129.5",
"productUrl": "https://www.site.com/store/product_acb",
"trackingUrl": "https://track.adtraction.com/t/t?a=24209996&as=24577691&t=2&tk=1",
"currency": "EUR",
"programId": 1062755777,
"approvalStatus": 1,
"ean": "0711719437215",
"sku": "abc123",
"extraInfo": [
{
"key": "color",
"value": "red"
}
],
"imageUrl": "http://www.site.com/store/product_acb.png",
"inStock": true,
"manufacturer": "Sony",
"manufacturerArticleNumber": "12345678",
"market": "SE",
"oldPrice": 45,
"productCategory": "Consoles",
"productDescription": "PlayStation 4 redefines rich and immersive gameplay with powerful graphics and speed.",
"shipping": 9
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Product feed info ¶
Retrieve product feed informationGET/partner/products/feedinfo/{programId}/{channelId}/{?token}
This endpoint is deprecated. Please use API version 3.
Retrieves information about a specified advertiser product feed, including number of available products, last updated status and link to download the data file.
Example URI
- programId
number(required) Example: 23959067Numerical ID of a partner program
- channelId
number(required) Example: 101496920Numerical ID of a channel
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: close- approvalStatus
number(optional)Approval status of a specified channel for a partner program: 0 = rejected, 1 = approved, 2 = pending review, 3 = not applied
- feedUrl
string(optional)URL to download the advertiser data feed. Only available when approvalStatus = 1. You can control the format of the file by modifing the following URL parameters: format (XML or CSV), encoding (UTF-8 or 8859-1), zip (0 or 1), cdelim (field separator) (tab, comma, colon, semi, pipe), tdelim (text qualifier) (singlequote or doubleqoute)
- lastUpdated
string(optional)UTC time stamp of when file was last updated
- numberOfProducts
number(optional)Number of products included in the file
Body
{
"approvalStatus": 1,
"feedUrl": "https://adtraction.com/productfeed.htm?type=feed&format=XML&encoding=UTF8&epi=0&zip=0&cdelim=tab&tdelim=singlequote&sd=0&flat=0&apid=23959067&asid=101496920",
"lastUpdated": "2018-01-01T10:15:12+0100",
"numberOfProducts": 12055
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"approvalStatus": {
"type": "number",
"description": "Approval status of a specified channel for a partner program: 0 = rejected, 1 = approved, 2 = pending review, 3 = not applied"
},
"feedUrl": {
"type": "string",
"description": "URL to download the advertiser data feed. Only available when approvalStatus = 1. You can control the format of the file by modifing the following URL parameters: format (XML or CSV), encoding (UTF-8 or 8859-1), zip (0 or 1), cdelim (field separator) (tab, comma, colon, semi, pipe), tdelim (text qualifier) (singlequote or doubleqoute)"
},
"lastUpdated": {
"type": "string",
"description": "UTC time stamp of when file was last updated"
},
"numberOfProducts": {
"type": "number",
"description": "Number of products included in the file"
}
}
}Coupons and offers ¶
List coupons and offersPOST/partner/offers/{?token}
Lists coupon codes, vouchers and offers available for partner programs on the Adtraction platform.
Example URI
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- market
string(optional)Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code
- programId
number(optional)Numerical ID of a partner program
- channelId
number(optional)Numerical ID of a channel
Body
{
"market": "SE",
"programId": 462891022,
"channelId": 24577691
}Schema
{
"type": "object",
"properties": {
"market": {
"type": "string",
"description": "Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code"
},
"programId": {
"type": "number",
"description": "Numerical ID of a partner program"
},
"channelId": {
"type": "number",
"description": "Numerical ID of a channel"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"logoURL": "https://secure.adtraction.com/image.htm?imgId=56807831",
"market": "SE",
"offerCoupon": "summersale123",
"offerDescription": "10 % discount on all bags",
"offerId": "1234567890",
"offerPage": "https://www.sportamore.se/offer",
"offerTerms": "Can not be combined with other offers",
"offerType": "1",
"programId": 1062755777,
"programName": "Sportamore",
"programUrl": "https://www.sportamore.se",
"trackingURL": "https://track.adtraction.com/t/t?a=24209996&as=24577691&t=2&tk=1",
"validFrom": "2018-01-01T00:00:00+0100",
"validTo": "2018-01-31T23:59:59+0100",
"lastUpdated": "2018-01-13T10:25:00+0100",
"createdDate": "2018-01-13T10:25:00+0100",
"categoryId": 1
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Clicks ¶
List clicksPOST/partner/clicks/{?token}
Lists clicks tracked in your account during a specified time period.
Example URI
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- fromDate
string(required)Oldest UTC time stamp of the dataset.
- toDate
string(required)Most recent UTC time stamp of the dataset.
- currency
string(required)Currency in ISO 4217 format
- programId
number(optional)Numerical ID of a partner program
- channelId
number(optional)Numerical ID of a channel
- market
string(optional)Country code of the market
- commissionOnly
boolean(optional)If set to true, only clicks with commission will be returned
- epi
string(optional)EPI extracted from the tracking link that generated the click
- epi2
string(optional)EPI2 extracted from the tracking link that generated the click
- epi3
string(optional)EPI3 extracted from the tracking link that generated the click
- epi4
string(optional)EPI4 extracted from the tracking link that generated the click
- epi5
string(optional)EPI5 extracted from the tracking link that generated the click
- wbraid
string(optional)Extracted from the tracking link that generated the click
- gbraid
string(optional)Extracted from the tracking link that generated the click
- gclid
string(optional)Google Click ID.
Body
{
"fromDate": "2019-08-10T00:00:00+0200",
"toDate": "2019-08-12T23:59:59+0200",
"currency": "SEK",
"programId": 1035156879,
"channelId": 141,
"market": "SE",
"commissionOnly": false,
"epi": "top_banner",
"epi2": "lorem",
"epi3": "ipsum",
"epi4": "dolor",
"epi5": "amet",
"wbraid": "123abc",
"gbraid": "abc123",
"gclid": "CMrlnPq42q8CFQdb3wodOkkGBg"
}Schema
{
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "Oldest UTC time stamp of the dataset."
},
"toDate": {
"type": "string",
"description": "Most recent UTC time stamp of the dataset."
},
"currency": {
"type": "string",
"description": "Currency in ISO 4217 format"
},
"programId": {
"type": "number",
"description": "Numerical ID of a partner program"
},
"channelId": {
"type": "number",
"description": "Numerical ID of a channel"
},
"market": {
"type": "string",
"description": "Country code of the market"
},
"commissionOnly": {
"type": "boolean",
"description": "If set to true, only clicks with commission will be returned"
},
"epi": {
"type": "string",
"description": "EPI extracted from the tracking link that generated the click"
},
"epi2": {
"type": "string",
"description": "EPI2 extracted from the tracking link that generated the click"
},
"epi3": {
"type": "string",
"description": "EPI3 extracted from the tracking link that generated the click"
},
"epi4": {
"type": "string",
"description": "EPI4 extracted from the tracking link that generated the click"
},
"epi5": {
"type": "string",
"description": "EPI5 extracted from the tracking link that generated the click"
},
"wbraid": {
"type": "string",
"description": "Extracted from the tracking link that generated the click"
},
"gbraid": {
"type": "string",
"description": "Extracted from the tracking link that generated the click"
},
"gclid": {
"type": "string",
"description": "Google Click ID."
}
},
"required": [
"fromDate",
"toDate",
"currency"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"adId": 26503038,
"adName": "980x120 summer sale",
"adType": "Image",
"channelId": 1062755777,
"clickDate": "2018-01-01T00:00:00+0100",
"programId": 1047411868,
"programName": "Sportamore",
"status": "Fresh",
"epi": "banner top right",
"epi2": "lorem",
"epi3": "ipsum",
"epi4": "dolor",
"epi5": "amet",
"wbraid": "123abc",
"gbraid": "abc123",
"gclid": "CMrlnPq42q8CFQdb3wodOkkGBg",
"cid": "415065613.1634041445",
"currency": "SEK",
"commission": 1.5
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Transactions ¶
Events that generate commissions are tracked in your Adtraction account.
List transactionsPOST/partner/transactions/{?token}
Lists transactions tracked in your account during a specified time period.
Example URI
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- fromDate
string(required)Oldest UTC time stamp of the dataset. For transactions, the time stamp designates at which the transaction was registered at the advertiser website
- toDate
string(required)Most recent UTC time stamp of the dataset. For transactions, the time stamp designates at which time the transaction was registered at the advertiser website
- lastUpdated
string(optional)If used as input, the dataset will only include transactions that were updated after the specified time
- transactionStatus
number(required)The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 0 = all, 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected
- epi
string(optional)EPI for the transaction. Extracted from the tracking link that generated the transaction
- market
string(optional)Geographical market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code
- currency
string(optional)Currency in ISO 4217 format
- programId
number(optional)Numerical ID of a partner program
- channelId
number(optional)Numerical ID of a channel
- paymentStatus
number(optional)Specifies what payment status of transaction should be included in the dataset. 1 = not invoiced, 2 = invoiced to advertiser, 3 = ready for payment, 4 = paid to partner
- uniqueId
string(optional)Unique ID for the transaction
Body
{
"fromDate": "2019-08-10T00:00:00+0200",
"toDate": "2019-08-12T23:59:59+0200",
"lastUpdated": "2019-08-11T23:59:59+0200",
"transactionStatus": 0,
"epi": "top_banner",
"market": "SE",
"currency": "SEK",
"programId": 1035156879,
"channelId": 141,
"paymentStatus": 4,
"uniqueId": "25862d1e-dc51-4fb2-82ae-24b8533ef417"
}Schema
{
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "Oldest UTC time stamp of the dataset. For transactions, the time stamp designates at which the transaction was registered at the advertiser website"
},
"toDate": {
"type": "string",
"description": "Most recent UTC time stamp of the dataset. For transactions, the time stamp designates at which time the transaction was registered at the advertiser website"
},
"lastUpdated": {
"type": "string",
"description": "If used as input, the dataset will only include transactions that were updated after the specified time"
},
"transactionStatus": {
"type": "number",
"description": "The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 0 = all, 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected"
},
"epi": {
"type": "string",
"description": "EPI for the transaction. Extracted from the tracking link that generated the transaction"
},
"market": {
"type": "string",
"description": "Geographical market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code"
},
"currency": {
"type": "string",
"description": "Currency in ISO 4217 format"
},
"programId": {
"type": "number",
"description": "Numerical ID of a partner program"
},
"channelId": {
"type": "number",
"description": "Numerical ID of a channel"
},
"paymentStatus": {
"type": "number",
"description": "Specifies what payment status of transaction should be included in the dataset. 1 = not invoiced, 2 = invoiced to advertiser, 3 = ready for payment, 4 = paid to partner"
},
"uniqueId": {
"type": "string",
"description": "Unique ID for the transaction"
}
},
"required": [
"fromDate",
"toDate",
"transactionStatus"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"click": {
"adId": 26503038,
"adName": "980x120 summer sale",
"adType": "Image",
"channelId": 1062755777,
"channelName": "John's business blog",
"clickDate": "2018-01-01T00:00:00+0100",
"programId": 1047411868,
"programName": "Sportamore",
"market": "SE",
"status": "Fresh",
"epi": "banner top right",
"epi2": "lorem",
"epi3": "ipsum",
"epi4": "dolor",
"epi5": "amet",
"wbraid": "123abc",
"gbraid": "abc123",
"gclid": "CMrlnPq42q8CFQdb3wodOkkGBg",
"cid": "415065613.1634041445"
},
"commission": 15,
"currency": "SEK",
"paymentStatus": 1,
"orderValue": 1000,
"originalCommission": 17.5,
"originalOrderValue": 175,
"reasonText": "Already attributed to another source",
"transactionDate": "2018-01-31T23:59:59+0100",
"lastUpdated": "2018-02-03T14:23:14+0100",
"autoApprovalDate": "2018-05-31",
"transactionName": "Order new customer",
"transactionType": 3,
"transactionStatus": 5,
"uniqueId": "25862d1e-dc51-4fb2-82ae-24b8533ef417",
"device": "smartphone",
"operatingSystem": "android",
"paymentId": 1047411868,
"geoLocation": "SE",
"productCategoryData": [
{
"categoryId": "widgets",
"categoryName": "Green widgets",
"orderValue": 1000,
"commission": 120
}
]
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Transactions in payment ¶
List transactions in a paymentGET/partner/transactions/payment/{paymentId}/{?token}
Lists transactions included in a specified payment generated in your Adtraction account.
Example URI
- paymentId
number(required) Example: 1107597351Numerical ID of a payment in your Adtraction account
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"click": {
"adId": 26503038,
"adName": "980x120 summer sale",
"adType": "Image",
"channelId": 1062755777,
"channelName": "John's business blog",
"clickDate": "2018-01-01T00:00:00+0100",
"programId": 1047411868,
"programName": "Sportamore",
"market": "SE",
"status": "Fresh",
"epi": "banner top right",
"epi2": "lorem",
"epi3": "ipsum",
"epi4": "dolor",
"epi5": "amet",
"wbraid": "123abc",
"gbraid": "abc123",
"gclid": "CMrlnPq42q8CFQdb3wodOkkGBg",
"cid": "415065613.1634041445"
},
"commission": 15,
"currency": "SEK",
"paymentStatus": 1,
"orderValue": 1000,
"originalCommission": 17.5,
"originalOrderValue": 175,
"reasonText": "Already attributed to another source",
"transactionDate": "2018-01-31T23:59:59+0100",
"lastUpdated": "2018-02-03T14:23:14+0100",
"transactionName": "Order new customer",
"transactionType": 3,
"transactionStatus": 5,
"uniqueId": "25862d1e-dc51-4fb2-82ae-24b8533ef417",
"device": "smartphone",
"operatingSystem": "android",
"paymentId": 1047411868,
"geoLocation": "SE",
"productCategoryData": [
{
"categoryId": "widgets",
"categoryName": "Green widgets",
"orderValue": 1000,
"commission": 120
}
]
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Transactions with gclid ¶
List transactions with gclidPOST/partner/transactions/gclid/{?token}
Lists transactions with a gclid (Google Click ID) value tracked in your account during a specified time period.
Example URI
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- fromDate
string(required)Oldest UTC time stamp of the dataset. For transactions, the time stamp designates at which the transaction was registered at the advertiser website
- toDate
string(required)Most recent UTC time stamp of the dataset. For transactions, the time stamp designates at which time the transaction was registered at the advertiser website
- transactionStatus
number(required)The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected
- programId
number(optional)Numerical ID of a partner program
- channelId
number(optional)Numerical ID of a channel
Body
{
"fromDate": "2019-08-10T00:00:00+0200",
"toDate": "2019-08-12T23:59:59+0200",
"transactionStatus": 0,
"programId": 1035156879,
"channelId": 141
}Schema
{
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "Oldest UTC time stamp of the dataset. For transactions, the time stamp designates at which the transaction was registered at the advertiser website"
},
"toDate": {
"type": "string",
"description": "Most recent UTC time stamp of the dataset. For transactions, the time stamp designates at which time the transaction was registered at the advertiser website"
},
"transactionStatus": {
"type": "number",
"description": "The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected"
},
"programId": {
"type": "number",
"description": "Numerical ID of a partner program"
},
"channelId": {
"type": "number",
"description": "Numerical ID of a channel"
}
},
"required": [
"fromDate",
"toDate",
"transactionStatus"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"click": {
"adId": 26503038,
"adName": "980x120 summer sale",
"adType": "Image",
"channelId": 1062755777,
"channelName": "John's business blog",
"clickDate": "2018-01-01T00:00:00+0100",
"programId": 1047411868,
"programName": "Sportamore",
"market": "SE",
"status": "Fresh",
"epi": "banner top right",
"epi2": "lorem",
"epi3": "ipsum",
"epi4": "dolor",
"epi5": "amet",
"wbraid": "123abc",
"gbraid": "abc123",
"gclid": "CMrlnPq42q8CFQdb3wodOkkGBg",
"cid": "415065613.1634041445"
},
"commission": 15,
"currency": "SEK",
"paymentStatus": 1,
"orderValue": 1000,
"originalCommission": 17.5,
"originalOrderValue": 175,
"reasonText": "Already attributed to another source",
"transactionDate": "2018-01-31T23:59:59+0100",
"lastUpdated": "2018-02-03T14:23:14+0100",
"autoApprovalDate": "2018-05-31",
"transactionName": "Order new customer",
"transactionType": 3,
"transactionStatus": 5,
"uniqueId": "25862d1e-dc51-4fb2-82ae-24b8533ef417",
"device": "smartphone",
"operatingSystem": "android",
"paymentId": 1047411868,
"geoLocation": "SE",
"productCategoryData": [
{
"categoryId": "widgets",
"categoryName": "Green widgets",
"orderValue": 1000,
"commission": 120
}
]
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Gclid transactions export ¶
Retreive gclid transactions reportGET/partner/gclid/{?token}
Returns a CSV file containing all transactions with a gclid (Google Click ID) value tracked in your account during the last 14 days. Can be used to import transactions into Google Ads if you prefer not to use our automated Google Ads integration.
Example URI
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8200Headers
Content-Encoding: UTF8
Content-Disposition: attachment; filename=c83c656a-1b65-47cf-90db-0bc4bee6fa51.csv
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Accept-Ranges: bytes
Content-Type: application/octet-stream
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeLatest transactions ¶
List latest transactionsGET/partner/transactions/latest/{number}/{?token}
Lists the latest transactions tracked in your account where transactionStatus = 1 (approved) or transactionStatus = 2 (pending).
Example URI
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
- number
number(optional) Example: 5Number of transactions to retrieve. Defaults to 10 if not specified
Headers
Content-Type: application/json;charset=UTF-8200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"click": {
"adId": 26503038,
"adName": "980x120 summer sale",
"adType": "Image",
"channelId": 1062755777,
"channelName": "John's business blog",
"clickDate": "2018-01-01T00:00:00+0100",
"programId": 1047411868,
"programName": "Sportamore",
"market": "SE",
"status": "Fresh",
"epi": "banner top right",
"epi2": "lorem",
"epi3": "ipsum",
"epi4": "dolor",
"epi5": "amet",
"wbraid": "123abc",
"gbraid": "abc123",
"gclid": "CMrlnPq42q8CFQdb3wodOkkGBg",
"cid": "415065613.1634041445"
},
"commission": 15,
"currency": "SEK",
"paymentStatus": 1,
"orderValue": 1000,
"originalCommission": 17.5,
"originalOrderValue": 175,
"reasonText": "Already attributed to another source",
"transactionDate": "2018-01-31T23:59:59+0100",
"lastUpdated": "2018-02-03T14:23:14+0100",
"autoApprovalDate": "2018-05-31",
"transactionName": "Order new customer",
"transactionType": 3,
"transactionStatus": 5,
"uniqueId": "25862d1e-dc51-4fb2-82ae-24b8533ef417",
"device": "smartphone",
"operatingSystem": "android",
"paymentId": 1047411868,
"geoLocation": "SE",
"productCategoryData": [
{
"categoryId": "widgets",
"categoryName": "Green widgets",
"orderValue": 1000,
"commission": 120
}
]
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Claims ¶
Create claimPUT/partner/claims/{?token}
Creates a claim for an untracked transaction. The commissionId can be obtained by using /partner/programs/commissions.
Example URI
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- programId
number(required)Numerical ID of a partner program
- channelId
number(required)Numerical ID of a channel
- orderId
string(required)Advertiser order ID
- commissionId
number(required)Numerical ID of the commission
- expectedCommission
number(optional)The expected commission amount for the claim. Should be used if the advertiser pays different commission for different product categories, meaning that a claim can consist of products from multiple categories, where each category gives the right to different commission.
- transactionDate
string(required)UTC timestamp of when the transaction was reported by the advertiser
- orderValue
number(required)Order value of the transaction
- currency
string(required)Currency in ISO 4217 format
- epi
string(optional)EPI value for the transaction
- epi2
string(optional)EPI2 value for the transaction
- epi3
string(optional)EPI3 value for the transaction
- epi4
string(optional)EPI4 value for the transaction
- epi5
string(optional)EPI5 value for the transaction
Body
{
"programId": 462891022,
"channelId": 24577691,
"orderId": "abc456_xyz",
"commissionId": 462891066,
"expectedCommission": 250.75,
"transactionDate": "2019-08-11T23:59:59+0100",
"orderValue": 1000,
"currency": "SEK",
"epi": "banner top right",
"epi2": "lorem",
"epi3": "ipsum",
"epi4": "dolor",
"epi5": "amet"
}Schema
{
"type": "object",
"properties": {
"programId": {
"type": "number",
"description": "Numerical ID of a partner program"
},
"channelId": {
"type": "number",
"description": "Numerical ID of a channel"
},
"orderId": {
"type": "string",
"description": "Advertiser order ID"
},
"commissionId": {
"type": "number",
"description": "Numerical ID of the commission"
},
"expectedCommission": {
"type": "number",
"description": "The expected commission amount for the claim. Should be used if the advertiser pays different commission for different product categories, meaning that a claim can consist of products from multiple categories, where each category gives the right to different commission. "
},
"transactionDate": {
"type": "string",
"description": "UTC timestamp of when the transaction was reported by the advertiser"
},
"orderValue": {
"type": "number",
"description": "Order value of the transaction"
},
"currency": {
"type": "string",
"description": "Currency in ISO 4217 format"
},
"epi": {
"type": "string",
"description": "EPI value for the transaction"
},
"epi2": {
"type": "string",
"description": "EPI2 value for the transaction"
},
"epi3": {
"type": "string",
"description": "EPI3 value for the transaction"
},
"epi4": {
"type": "string",
"description": "EPI4 value for the transaction"
},
"epi5": {
"type": "string",
"description": "EPI5 value for the transaction"
}
},
"required": [
"programId",
"channelId",
"orderId",
"commissionId",
"transactionDate",
"orderValue",
"currency"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: close- success
boolean(optional)True on successful submit. Unsuccessful submit will instead return error (string) and errorCode (number)
Body
{
"success": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "True on successful submit. Unsuccessful submit will instead return error (string) and errorCode (number)"
}
}
}Statistics ¶
The Adtraction system tracks ad impressions, clicks, transactions and the corresponding commission for each channel and partner program.
Retrieve statisticsPOST/partner/statistics/{?token}
Returns the aggregation of statistics across a defined time period.
Example URI
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- fromDate
string(required)The start date of the requested range in ISO 8601 date format
- toDate
string(required)The end date of the requested range in ISO 8601 date format
- currency
string(required)Currency in ISO 4217 format
- market
string(required)Market defined by an ISO 3166-1 Alpha-2 country code
- transactionStatus
number(required)The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected
- programId
number(optional)Numerical ID of a partner program
- channelId
number(optional)Numerical ID of a partner channel
Body
{
"fromDate": "2018-05-17",
"toDate": "2018-05-23",
"currency": "SEK",
"market": "SE",
"transactionStatus": 1,
"programId": 24209985,
"channelId": 49326900
}Schema
{
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "The start date of the requested range in ISO 8601 date format"
},
"toDate": {
"type": "string",
"description": "The end date of the requested range in ISO 8601 date format"
},
"currency": {
"type": "string",
"description": "Currency in ISO 4217 format"
},
"market": {
"type": "string",
"description": "Market defined by an ISO 3166-1 Alpha-2 country code"
},
"transactionStatus": {
"type": "number",
"description": "The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected"
},
"programId": {
"type": "number",
"description": "Numerical ID of a partner program"
},
"channelId": {
"type": "number",
"description": "Numerical ID of a partner channel"
}
},
"required": [
"fromDate",
"toDate",
"currency",
"market",
"transactionStatus"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: close- clicks
number(optional)Number of clicks
- clicksUnique
number(optional)Number of unique clicks
- commission
number(optional)Amount of partner commission
- currency
string(optional)Currency in ISO 4217 format
- impressions
number(optional)Number of banner / links impressions
- impressionsUnique
number(optional)Number of unique banner / links impressions
- leads
number(optional)Number of lead transactions
- sales
number(optional)Number of sale transactions
- orderValue
number(optional)Order value of the sale transactions
- epc
number(optional)Earnings Per Click obtained by dividing the commission by clicksUnique
- ctr
number(optional)Click Through Ratio, obtained by dividing clicks by impressions
- leadRatio
number(optional)Lead Ratio, obtained by dividing leads by clicksUnique
Body
{
"clicks": 150,
"clicksUnique": 100,
"commission": 500,
"currency": "EUR",
"impressions": 1500,
"impressionsUnique": 1300,
"leads": 20,
"sales": 10,
"orderValue": 1000,
"epc": 10,
"ctr": 0.06666,
"leadRatio": 0.2
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"clicks": {
"type": "number",
"description": "Number of clicks"
},
"clicksUnique": {
"type": "number",
"description": "Number of unique clicks"
},
"commission": {
"type": "number",
"description": "Amount of partner commission"
},
"currency": {
"type": "string",
"description": "Currency in ISO 4217 format"
},
"impressions": {
"type": "number",
"description": "Number of banner / links impressions"
},
"impressionsUnique": {
"type": "number",
"description": "Number of unique banner / links impressions"
},
"leads": {
"type": "number",
"description": "Number of lead transactions"
},
"sales": {
"type": "number",
"description": "Number of sale transactions"
},
"orderValue": {
"type": "number",
"description": "Order value of the sale transactions"
},
"epc": {
"type": "number",
"description": "Earnings Per Click obtained by dividing the commission by clicksUnique"
},
"ctr": {
"type": "number",
"description": "Click Through Ratio, obtained by dividing clicks by impressions"
},
"leadRatio": {
"type": "number",
"description": "Lead Ratio, obtained by dividing leads by clicksUnique"
}
}
}Statistics by ad ¶
Retrieve statistics by adPOST/partner/statistics/ads/{?token}
Returns the aggregation of statistics, grouped by ad, across a defined time period.
Example URI
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- fromDate
string(required)The start date of the requested range in ISO 8601 date format
- toDate
string(required)The end date of the requested range in ISO 8601 date format
- currency
string(required)Currency in ISO 4217 format
- market
string(required)Market defined by an ISO 3166-1 Alpha-2 country code
- transactionStatus
number(required)The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected
- programId
number(optional)Numerical ID of a partner program
- channelId
number(optional)Numerical ID of a partner channel
Body
{
"fromDate": "2018-05-17",
"toDate": "2018-05-23",
"currency": "SEK",
"market": "SE",
"transactionStatus": 1,
"programId": 24209985,
"channelId": 49326900
}Schema
{
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "The start date of the requested range in ISO 8601 date format"
},
"toDate": {
"type": "string",
"description": "The end date of the requested range in ISO 8601 date format"
},
"currency": {
"type": "string",
"description": "Currency in ISO 4217 format"
},
"market": {
"type": "string",
"description": "Market defined by an ISO 3166-1 Alpha-2 country code"
},
"transactionStatus": {
"type": "number",
"description": "The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected"
},
"programId": {
"type": "number",
"description": "Numerical ID of a partner program"
},
"channelId": {
"type": "number",
"description": "Numerical ID of a partner channel"
}
},
"required": [
"fromDate",
"toDate",
"currency",
"market",
"transactionStatus"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
X-RateLimit-Limit: 10
X-RateLimit-Remaining: 9
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"adId": 1062755777,
"adName": "980x120 summer sale",
"clicks": 150,
"clicksUnique": 100,
"commission": 500,
"currency": "EUR",
"impressions": 1500,
"impressionsUnique": 1300,
"leads": 20,
"sales": 10,
"orderValue": 1000,
"epc": 10,
"ctr": 0.06666,
"leadRatio": 0.2,
"conversionRatio": 0.1
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Statistics by channel ¶
Retrieve statistics by channelPOST/partner/statistics/channels/{?token}
Returns the aggregation of statistics, grouped by channel, across a defined time period.
Example URI
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- fromDate
string(required)The start date of the requested range in ISO 8601 date format
- toDate
string(required)The end date of the requested range in ISO 8601 date format
- currency
string(required)Currency in ISO 4217 format
- market
string(required)Market defined by an ISO 3166-1 Alpha-2 country code
- transactionStatus
number(required)The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected
- programId
number(optional)Numerical ID of a partner program
- channelId
number(optional)Numerical ID of a partner channel
Body
{
"fromDate": "2018-05-17",
"toDate": "2018-05-23",
"currency": "SEK",
"market": "SE",
"transactionStatus": 1,
"programId": 24209985,
"channelId": 49326900
}Schema
{
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "The start date of the requested range in ISO 8601 date format"
},
"toDate": {
"type": "string",
"description": "The end date of the requested range in ISO 8601 date format"
},
"currency": {
"type": "string",
"description": "Currency in ISO 4217 format"
},
"market": {
"type": "string",
"description": "Market defined by an ISO 3166-1 Alpha-2 country code"
},
"transactionStatus": {
"type": "number",
"description": "The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected"
},
"programId": {
"type": "number",
"description": "Numerical ID of a partner program"
},
"channelId": {
"type": "number",
"description": "Numerical ID of a partner channel"
}
},
"required": [
"fromDate",
"toDate",
"currency",
"market",
"transactionStatus"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
X-RateLimit-Limit: 10
X-RateLimit-Remaining: 9
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"channelId": 24577691,
"channelName": "John's business blog",
"clicks": 150,
"clicksUnique": 100,
"commission": 500,
"currency": "EUR",
"impressions": 1500,
"impressionsUnique": 1300,
"leads": 20,
"sales": 10,
"orderValue": 1000,
"epc": 10,
"ctr": 0.06666,
"leadRatio": 0.2,
"conversionRatio": 0.1
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Statistics by day ¶
Retrieve statistics by dayPOST/partner/statistics/days/{?token}
Returns the aggregation of statistics, grouped by day, across a defined time period.
Example URI
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- fromDate
string(required)The start date of the requested range in ISO 8601 date format
- toDate
string(required)The end date of the requested range in ISO 8601 date format
- currency
string(required)Currency in ISO 4217 format
- market
string(required)Market defined by an ISO 3166-1 Alpha-2 country code
- transactionStatus
number(required)The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected
- programId
number(optional)Numerical ID of a partner program
- channelId
number(optional)Numerical ID of a partner channel
Body
{
"fromDate": "2018-05-17",
"toDate": "2018-05-23",
"currency": "SEK",
"market": "SE",
"transactionStatus": 1,
"programId": 24209985,
"channelId": 49326900
}Schema
{
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "The start date of the requested range in ISO 8601 date format"
},
"toDate": {
"type": "string",
"description": "The end date of the requested range in ISO 8601 date format"
},
"currency": {
"type": "string",
"description": "Currency in ISO 4217 format"
},
"market": {
"type": "string",
"description": "Market defined by an ISO 3166-1 Alpha-2 country code"
},
"transactionStatus": {
"type": "number",
"description": "The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected"
},
"programId": {
"type": "number",
"description": "Numerical ID of a partner program"
},
"channelId": {
"type": "number",
"description": "Numerical ID of a partner channel"
}
},
"required": [
"fromDate",
"toDate",
"currency",
"market",
"transactionStatus"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
X-RateLimit-Limit: 10
X-RateLimit-Remaining: 9
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"date": "2018-05-17",
"clicks": 150,
"clicksUnique": 100,
"commission": 500,
"currency": "EUR",
"impressions": 1500,
"impressionsUnique": 1300,
"leads": 20,
"sales": 10,
"orderValue": 1000,
"epc": 10,
"ctr": 0.06666,
"leadRatio": 0.2,
"conversionRatio": 0.1
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Statistics by EPI ¶
Retrieve statistics by EPIPOST/partner/statistics/epi/{?token}
Returns the aggregation of statistics, grouped by EPI values, across a defined time period.
Example URI
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- fromDate
string(required)The start date of the requested range in ISO 8601 date format
- toDate
string(required)The end date of the requested range in ISO 8601 date format
- currency
string(required)Currency in ISO 4217 format
- market
string(required)Market defined by an ISO 3166-1 Alpha-2 country code
- transactionStatus
number(required)The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected
- programId
number(optional)Numerical ID of a partner program
- channelId
number(optional)Numerical ID of a partner channel
- groupbyEpi
boolean(optional)Determines whether the output should be grouped by the EPI attribute. Defaults to true.
- groupbyEpi2
boolean(optional)Determines whether the output should be grouped by the EPI2 attribute. Defaults to false.
- groupbyEpi3
boolean(optional)Determines whether the output should be grouped by the EPI3 attribute. Defaults to false.
- groupbyEpi4
boolean(optional)Determines whether the output should be grouped by the EPI4 attribute. Defaults to false.
- groupbyEpi5
boolean(optional)Determines whether the output should be grouped by the EPI5 attribute. Defaults to false.
Body
{
"fromDate": "2018-05-17",
"toDate": "2018-05-23",
"currency": "SEK",
"market": "SE",
"transactionStatus": 1,
"programId": 24209985,
"channelId": 49326900,
"groupbyEpi": true,
"groupbyEpi2": false,
"groupbyEpi3": false,
"groupbyEpi4": false,
"groupbyEpi5": false
}Schema
{
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "The start date of the requested range in ISO 8601 date format"
},
"toDate": {
"type": "string",
"description": "The end date of the requested range in ISO 8601 date format"
},
"currency": {
"type": "string",
"description": "Currency in ISO 4217 format"
},
"market": {
"type": "string",
"description": "Market defined by an ISO 3166-1 Alpha-2 country code"
},
"transactionStatus": {
"type": "number",
"description": "The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected"
},
"programId": {
"type": "number",
"description": "Numerical ID of a partner program"
},
"channelId": {
"type": "number",
"description": "Numerical ID of a partner channel"
},
"groupbyEpi": {
"type": "boolean",
"description": "Determines whether the output should be grouped by the EPI attribute. Defaults to true."
},
"groupbyEpi2": {
"type": "boolean",
"description": "Determines whether the output should be grouped by the EPI2 attribute. Defaults to false."
},
"groupbyEpi3": {
"type": "boolean",
"description": "Determines whether the output should be grouped by the EPI3 attribute. Defaults to false."
},
"groupbyEpi4": {
"type": "boolean",
"description": "Determines whether the output should be grouped by the EPI4 attribute. Defaults to false."
},
"groupbyEpi5": {
"type": "boolean",
"description": "Determines whether the output should be grouped by the EPI5 attribute. Defaults to false."
}
},
"required": [
"fromDate",
"toDate",
"currency",
"market",
"transactionStatus"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
X-RateLimit-Limit: 10
X-RateLimit-Remaining: 9
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: close- sample_epi
object(optional)EPI values extracted from the tracking link that generated the clicks or transactions
- clicks
number(optional)Number of clicks
- clicksUnique
number(optional)Number of unique clicks
- commission
number(optional)Amount of partner commission
- currency
string(optional)Currency in ISO 4217 format
- leads
number(optional)Number of lead transactions
- sales
number(optional)Number of sale transactions
- orderValue
number(optional)Order value of the sale transactions
- epc
number(optional)Earnings Per Click obtained by dividing the commission by clicksUnique
- aov
number(optional)Average order value, obtained by dividing order value by number of sale transactions
- leadRatio
number(optional)Lead Ratio, obtained by dividing leads by clicksUnique
- conversionRatio
number(optional)Conversion Ratio, obtained by dividing sales by clicksUnique
Body
{
"sample_epi": {
"clicks": 150,
"clicksUnique": 100,
"commission": 500,
"currency": "EUR",
"leads": 20,
"sales": 10,
"orderValue": 1000,
"epc": 10,
"aov": 100.87,
"leadRatio": 0.2,
"conversionRatio": 0.1
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"sample_epi": {
"type": "object",
"properties": {
"clicks": {
"type": "number",
"description": "Number of clicks"
},
"clicksUnique": {
"type": "number",
"description": "Number of unique clicks"
},
"commission": {
"type": "number",
"description": "Amount of partner commission"
},
"currency": {
"type": "string",
"description": "Currency in ISO 4217 format"
},
"leads": {
"type": "number",
"description": "Number of lead transactions"
},
"sales": {
"type": "number",
"description": "Number of sale transactions"
},
"orderValue": {
"type": "number",
"description": "Order value of the sale transactions"
},
"epc": {
"type": "number",
"description": "Earnings Per Click obtained by dividing the commission by clicksUnique"
},
"aov": {
"type": "number",
"description": "Average order value, obtained by dividing order value by number of sale transactions"
},
"leadRatio": {
"type": "number",
"description": "Lead Ratio, obtained by dividing leads by clicksUnique"
},
"conversionRatio": {
"type": "number",
"description": "Conversion Ratio, obtained by dividing sales by clicksUnique"
}
},
"description": "EPI values extracted from the tracking link that generated the clicks or transactions"
}
}
}Statistics by program ¶
Retrieve statistics by programPOST/partner/statistics/programs/{?token}
Returns the aggregation of statistics, grouped by program, across a defined time period.
Example URI
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- fromDate
string(required)The start date of the requested range in ISO 8601 date format
- toDate
string(required)The end date of the requested range in ISO 8601 date format
- currency
string(required)Currency in ISO 4217 format
- market
string(required)Market defined by an ISO 3166-1 Alpha-2 country code
- transactionStatus
number(required)The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected
- programId
number(optional)Numerical ID of a partner program
- channelId
number(optional)Numerical ID of a partner channel
Body
{
"fromDate": "2018-05-17",
"toDate": "2018-05-23",
"currency": "SEK",
"market": "SE",
"transactionStatus": 1,
"programId": 24209985,
"channelId": 49326900
}Schema
{
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "The start date of the requested range in ISO 8601 date format"
},
"toDate": {
"type": "string",
"description": "The end date of the requested range in ISO 8601 date format"
},
"currency": {
"type": "string",
"description": "Currency in ISO 4217 format"
},
"market": {
"type": "string",
"description": "Market defined by an ISO 3166-1 Alpha-2 country code"
},
"transactionStatus": {
"type": "number",
"description": "The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected"
},
"programId": {
"type": "number",
"description": "Numerical ID of a partner program"
},
"channelId": {
"type": "number",
"description": "Numerical ID of a partner channel"
}
},
"required": [
"fromDate",
"toDate",
"currency",
"market",
"transactionStatus"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
X-RateLimit-Limit: 10
X-RateLimit-Remaining: 9
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"programId": 52561763,
"programName": "Stayhard SE",
"clicks": 150,
"clicksUnique": 100,
"commission": 500,
"currency": "EUR",
"impressions": 1500,
"impressionsUnique": 1300,
"leads": 20,
"sales": 10,
"orderValue": 1000,
"epc": 10,
"ctr": 0.06666,
"leadRatio": 0.2,
"conversionRatio": 0.1
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Commission by type ¶
Retrieve commission by typePOST/partner/commission/type/{?token}
Returns the aggregation of commission earned across a defined time period, grouped by type.
Example URI
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- fromDate
string(required)The start date of the requested range in ISO 8601 date format
- toDate
string(required)The end date of the requested range in ISO 8601 date format
- currency
string(required)The numerical ID of a partner channel
- transactionStatus
number(required)The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected
- market
string(optional)Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code
- programId
number(optional)Numerical ID of a partner program
- channelId
number(optional)Numerical ID of a partner channel
Body
{
"fromDate": "2018-05-17",
"toDate": "2018-05-23",
"currency": "SEK",
"transactionStatus": 1,
"market": "SE",
"programId": 1047411868,
"channelId": 1062755777
}Schema
{
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "The start date of the requested range in ISO 8601 date format"
},
"toDate": {
"type": "string",
"description": "The end date of the requested range in ISO 8601 date format"
},
"currency": {
"type": "string",
"description": "The numerical ID of a partner channel"
},
"transactionStatus": {
"type": "number",
"description": "The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected"
},
"market": {
"type": "string",
"description": "Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code"
},
"programId": {
"type": "number",
"description": "Numerical ID of a partner program"
},
"channelId": {
"type": "number",
"description": "Numerical ID of a partner channel"
}
},
"required": [
"fromDate",
"toDate",
"currency",
"transactionStatus"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: close- saleCommission
number(optional)Amount of commission that derives from transactions of type Sale
- leadCommission
number(optional)Amount of commission that derives from transactions of type Lead
- clickCommission
number(optional)Amount of commission that derives from clicks
- otherCommission
number(optional)Amount of commission that does not derive from transactions or clicks. Typically manually added by Adtraction admin
- totalCommission
number(optional)Total amount of commission for the period, ie the sum of saleCommission, leadCommission, clickCommission and otherCommission
Body
{
"saleCommission": 100,
"leadCommission": 100,
"clickCommission": 100,
"otherCommission": 100,
"totalCommission": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"saleCommission": {
"type": "number",
"description": "Amount of commission that derives from transactions of type Sale "
},
"leadCommission": {
"type": "number",
"description": "Amount of commission that derives from transactions of type Lead"
},
"clickCommission": {
"type": "number",
"description": "Amount of commission that derives from clicks"
},
"otherCommission": {
"type": "number",
"description": "Amount of commission that does not derive from transactions or clicks. Typically manually added by Adtraction admin"
},
"totalCommission": {
"type": "number",
"description": "Total amount of commission for the period, ie the sum of saleCommission, leadCommission, clickCommission and otherCommission"
}
}
}Commission by payment status ¶
Retrieve commission by payment statusPOST/partner/commission/paymentstatus/{?token}
Returns the aggregation of commission earned across a defined time period, grouped by payment status.
Example URI
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- fromDate
string(required)The start date of the requested range in ISO 8601 date format
- toDate
string(required)The end date of the requested range in ISO 8601 date format
- currency
string(required)The numerical ID of a partner channel
- market
string(optional)Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code
- programId
number(optional)Numerical ID of a partner program
- channelId
number(optional)Numerical ID of a partner channel
Body
{
"fromDate": "2018-05-17",
"toDate": "2018-05-23",
"currency": "SEK",
"market": "SE",
"programId": 1047411868,
"channelId": 1062755777
}Schema
{
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "The start date of the requested range in ISO 8601 date format"
},
"toDate": {
"type": "string",
"description": "The end date of the requested range in ISO 8601 date format"
},
"currency": {
"type": "string",
"description": "The numerical ID of a partner channel"
},
"market": {
"type": "string",
"description": "Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code"
},
"programId": {
"type": "number",
"description": "Numerical ID of a partner program"
},
"channelId": {
"type": "number",
"description": "Numerical ID of a partner channel"
}
},
"required": [
"fromDate",
"toDate",
"currency"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: close- paymentstatus
object(optional)- 1
number(optional)Not invoiced
- 2
number(optional)Invoiced to advertiser
- 3
number(optional)Ready for payment
- 4
number(optional)Paid to partner
Body
{
"paymentstatus": {
"1": 105.35,
"2": 740.85,
"3": 420.56,
"4": 201.33
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"paymentstatus": {
"type": "object",
"properties": {
"1": {
"type": "number",
"description": "Not invoiced"
},
"2": {
"type": "number",
"description": "Invoiced to advertiser"
},
"3": {
"type": "number",
"description": "Ready for payment"
},
"4": {
"type": "number",
"description": "Paid to partner"
}
}
}
}
}Commission by transaction status ¶
Retrieve commission by transaction statusPOST/partner/commission/transactionstatus/{?token}
Returns the aggregation of commission earned across a defined time period, grouped by transaction status.
Example URI
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- fromDate
string(required)The start date of the requested range in ISO 8601 date format
- toDate
string(required)The end date of the requested range in ISO 8601 date format
- currency
string(required)The numerical ID of a partner channel
- market
string(optional)Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code
- programId
number(optional)Numerical ID of a partner program
- channelId
number(optional)Numerical ID of a partner channel
Body
{
"fromDate": "2018-05-17",
"toDate": "2018-05-23",
"currency": "SEK",
"market": "SE",
"programId": 1047411868,
"channelId": 1062755777
}Schema
{
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "The start date of the requested range in ISO 8601 date format"
},
"toDate": {
"type": "string",
"description": "The end date of the requested range in ISO 8601 date format"
},
"currency": {
"type": "string",
"description": "The numerical ID of a partner channel"
},
"market": {
"type": "string",
"description": "Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code"
},
"programId": {
"type": "number",
"description": "Numerical ID of a partner program"
},
"channelId": {
"type": "number",
"description": "Numerical ID of a partner channel"
}
},
"required": [
"fromDate",
"toDate",
"currency"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: close- transactionstatus
object(optional)- 1
number(optional)Approved
- 2
number(optional)Pending
- 4
number(optional)Open claims
- 5
number(optional)Rejected
Body
{
"transactionstatus": {
"1": 105.35,
"2": 740.85,
"4": 201.33,
"5": 111.23
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"transactionstatus": {
"type": "object",
"properties": {
"1": {
"type": "number",
"description": "Approved"
},
"2": {
"type": "number",
"description": "Pending"
},
"4": {
"type": "number",
"description": "Open claims"
},
"5": {
"type": "number",
"description": "Rejected"
}
}
}
}
}Account balance ¶
Commission earned from advertisers on the Adtraction platform will accumulate in the account balance in your Adtraction account.
Retreive account balanceGET/partner/balance/{currency}/{?token}
Retrieves your account balance for a specified currency (ISO 4217).
Example URI
- currency
string(required) Example: SEKCurrency in ISO 4217 format
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8200Headers
X-RateLimit-Limit: 10
X-RateLimit-Remaining: 9
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: close- pendingBalance
number(optional)Some advertisers review transactions manually. This amount is the sum of transactions that have the status pending until they are approved or rejected by the advertiser
- confirmedBalance
number(optional)Amount that has been confirmed by the advertiser and will be included on the next invoice Adtraction sends to the advertiser
- invoicedBalance
number(optional)Amount that has been invoiced by Adtraction but have not yet been paid by the advertiser
- payableBalance
number(optional)Amount that has been paid by the advertiser and will be included on the next payment made to you from Adtraction
- totalBalance
number(optional)Total account balance
Body
{
"pendingBalance": 100,
"confirmedBalance": 200,
"invoicedBalance": 300,
"payableBalance": 400,
"totalBalance": 1000
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"pendingBalance": {
"type": "number",
"description": "Some advertisers review transactions manually. This amount is the sum of transactions that have the status pending until they are approved or rejected by the advertiser"
},
"confirmedBalance": {
"type": "number",
"description": "Amount that has been confirmed by the advertiser and will be included on the next invoice Adtraction sends to the advertiser"
},
"invoicedBalance": {
"type": "number",
"description": "Amount that has been invoiced by Adtraction but have not yet been paid by the advertiser"
},
"payableBalance": {
"type": "number",
"description": "Amount that has been paid by the advertiser and will be included on the next payment made to you from Adtraction"
},
"totalBalance": {
"type": "number",
"description": "Total account balance"
}
}
}Payments ¶
Commission earned from advertisers on the Adtraction platform will be paid on a monthly basis.
List paymentsGET/partner/payments/{currency}/{paymentId}/{?token}
Lists payments generated in you Adtraction account.
Example URI
- currency
string(optional) Example: SEKCurrency in ISO 4217 format. Only payments in the specified currency will be included in the dataset
- paymentId
number(optional) Example: 1401232332Numerical ID of a payment generated in your Adtraction account
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"currency": "EUR",
"exchangeRate": 0.6539,
"originalCurrency": "SEK",
"paymentdate": "2018-01-31T23:59:59+0100",
"paymentId": 1047411868,
"totalAmount": 100,
"taxAmount": 25,
"vatAmount": 25
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Payment specification ¶
Each payment generated in your Adtractions account will have a specifiction in PDF format.
Retrieve payment specification PDFGET/partner/payments/pdf/{paymentId}/{?token}
Downloads a specified payment specification in PDF format.
Example URI
- paymentId
number(required) Example: 1401232332Numerical ID of a payment generated in your Adtraction account
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8200Headers
Content-Encoding: UTF8
Content-Disposition: attachment; filename=Adtraction_1107597351_2018-12-15.pdf
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Accept-Ranges: bytes
Content-Type: application/octet-stream
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeTracking errors ¶
List tracking errorsPOST/partner/tracking/errors/{?token}
Lists tracking errors that have occurred in your account during the last seven days. Tracking errors older than seven days are automatically deleted and no data is available.
Example URI
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- channelId
number(optional)Numerical ID of a channel
- programId
number(optional)Numerical ID of a partner program
Body
{
"channelId": 24577691,
"programId": 52561763
}Schema
{
"type": "object",
"properties": {
"channelId": {
"type": "number",
"description": "Numerical ID of a channel"
},
"programId": {
"type": "number",
"description": "Numerical ID of a partner program"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"channelId": 24577691,
"channelName": "John's business blog",
"programId": 26503027,
"programName": "Blueride",
"actionDate": "2018-01-01T10:15:10+0100",
"actionType": "click",
"errorType": "The channel is not approved by the advertiser",
"trackingUrl": "https://track.adtraction.com/t/t?a=24209996&as=24577691&t=2&tk=1",
"fallbackAction": 31,
"referer": "https://www.site.com/page.htm"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Tracking link ¶
Retrieve tracking linkPOST/partner/tracking/link/{?token}
Retrieves an Adtraction tracking link for a specified program and channel.
Example URI
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- channelId
number(required)Numerical ID of a channel
- programId
number(required)Numerical ID of a partner program
- shortLink
boolean(optional)If set to true, the output will be a short link instead of a traditional tracking link
- url
string(optional)URL to the web page you want to link to. Must include protocol (“http:” or “https:”) and be located on the advertiser’s domain.
- epi
string(optional)EPI value to be inserted into the tracking link
- epi2
string(optional)EPI2 value to be inserted into the tracking link
- epi3
string(optional)EPI3 value to be inserted into the tracking link
- epi4
string(optional)EPI4 value to be inserted into the tracking link
- epi5
string(optional)EPI5 value to be inserted into the tracking link
Body
{
"channelId": 24577691,
"programId": 52561763,
"shortLink": false,
"url": "https://www.stayhard.se/skor",
"epi": "banner top right",
"epi2": "lorem",
"epi3": "ipsum",
"epi4": "dolor",
"epi5": "amet"
}Schema
{
"type": "object",
"properties": {
"channelId": {
"type": "number",
"description": "Numerical ID of a channel"
},
"programId": {
"type": "number",
"description": "Numerical ID of a partner program"
},
"shortLink": {
"type": "boolean",
"description": "If set to true, the output will be a short link instead of a traditional tracking link"
},
"url": {
"type": "string",
"description": "URL to the web page you want to link to. Must include protocol (\"http:\" or \"https:\") and be located on the advertiser's domain."
},
"epi": {
"type": "string",
"description": "EPI value to be inserted into the tracking link"
},
"epi2": {
"type": "string",
"description": "EPI2 value to be inserted into the tracking link"
},
"epi3": {
"type": "string",
"description": "EPI3 value to be inserted into the tracking link"
},
"epi4": {
"type": "string",
"description": "EPI4 value to be inserted into the tracking link"
},
"epi5": {
"type": "string",
"description": "EPI5 value to be inserted into the tracking link"
}
},
"required": [
"channelId",
"programId"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: close- trackingUrl
string(optional)Click tracking link for a specified channel and partner program, where “a” is the adId and “as” is the channelId.
Body
{
"trackingUrl": "https://track.adtraction.com/t/t?a=52561789&as=24577691&t=2&tk=1&url=https://www.stayhard.se/skor"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"trackingUrl": {
"type": "string",
"description": "Click tracking link for a specified channel and partner program, where \"a\" is the adId and \"as\" is the channelId."
}
}
}Advertiser ¶
Account ¶
Account detailsGET/advertiser/account/{?token}
Returns details about your Adtraction advertiser account.
Example URI
- token
string(required) Example: D0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8200Headers
X-RateLimit-Limit: 10
X-RateLimit-Remaining: 9
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: close- programId
number(optional)Numerical ID of your program
- programName
string(optional)Name of your program
- currency
string(optional)The currency used in your account in ISO 4217 format
- market
string(optional)The Market on which your program is available, defined by an ISO 3166-1 Alpha-2 country code
Body
{
"programId": 52561763,
"programName": "Ferratum SE",
"currency": "SEK",
"market": "SE"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"programId": {
"type": "number",
"description": "Numerical ID of your program"
},
"programName": {
"type": "string",
"description": "Name of your program"
},
"currency": {
"type": "string",
"description": "The currency used in your account in ISO 4217 format"
},
"market": {
"type": "string",
"description": "The Market on which your program is available, defined by an ISO 3166-1 Alpha-2 country code"
}
}
}Channels ¶
A channel is where a partner places banners or links to promote your partner program. It can be, for example, a website, a blog or a newsletter. It may also be paid advertising on, for example, Adwords or Facebook.
List channelsPOST/advertiser/channels/{?token}
This endpoint is deprecated. Please use API version 3.
Lists all channels that have applied to your program.
Example URI
- token
string(required) Example: D0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- channelId
number(optional)Numerical ID of a channel.
- affiliateId
number(optional)Numerical ID of a partner account.
- approvalStatus
number(optional)Approval status of a channel for a partner program: 0 = rejected, 1 = approved, 2 = pending review
Body
{
"channelId": 26148592,
"affiliateId": 26148590,
"approvalStatus": 1
}Schema
{
"type": "object",
"properties": {
"channelId": {
"type": "number",
"description": "Numerical ID of a channel."
},
"affiliateId": {
"type": "number",
"description": "Numerical ID of a partner account."
},
"approvalStatus": {
"type": "number",
"description": "Approval status of a channel for a partner program: 0 = rejected, 1 = approved, 2 = pending review"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"affiliateId": 906248154,
"affiliateName": "John Doe",
"channelId": 1062755777,
"channelName": "John's business blog",
"channelDescription": "A blog about business.",
"channelUrl": "https://www.johnsblog.com",
"channelType": "Blog",
"approvalStatus": 1,
"applicationDate": "2021-11-31"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Update channel statusPUT/advertiser/channels/{?token}
This endpoint is deprecated. Please use API version 3.
Update the approval status for a channel in your program. Status can be updated to rejected (0) or approved (1).
Example URI
- token
string(required) Example: D0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- channelId
number(optional)Numerical ID of a channel.
- approvalStatus
number(optional)Approval status of a channel for a partner program: 0 = rejected, 1 = approved
Body
{
"channelId": 26148592,
"approvalStatus": 1
}Schema
{
"type": "object",
"properties": {
"channelId": {
"type": "number",
"description": "Numerical ID of a channel."
},
"approvalStatus": {
"type": "number",
"description": "Approval status of a channel for a partner program: 0 = rejected, 1 = approved"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: close- success
boolean(optional)True or false
Body
{
"success": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "True or false"
}
}
}Clicks ¶
List clicksPOST/advertiser/clicks/{?token}
Lists clicks tracked in your account during a specified time period. NB: clicks older than 14 months are not available.
Example URI
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- fromDate
string(required)Oldest UTC time stamp of the dataset.
- toDate
string(required)Most recent UTC time stamp of the dataset.
- channelId
number(optional)Numerical ID of a channel
Body
{
"fromDate": "2019-08-10T00:00:00+0200",
"toDate": "2019-08-12T23:59:59+0200",
"channelId": 141
}Schema
{
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "Oldest UTC time stamp of the dataset."
},
"toDate": {
"type": "string",
"description": "Most recent UTC time stamp of the dataset."
},
"channelId": {
"type": "number",
"description": "Numerical ID of a channel"
}
},
"required": [
"fromDate",
"toDate"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
X-RateLimit-Limit: 10
X-RateLimit-Remaining: 9
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"adId": 26503038,
"adName": "980x120 summer sale",
"adType": "Image",
"channelId": 1062755777,
"channelName": "John's business blog",
"clickDate": "2018-01-01T00:00:00+0100",
"status": "Fresh"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Transactions ¶
Events that generate commission are tracked in your Adtraction account.
List transactionsPOST/advertiser/transactions/{?token}
Lists transactions tracked in your account during a specified time period.
Example URI
- token
string(required) Example: D0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- fromDate
string(required)Oldest UTC time stamp of the dataset. For transactions, the time stamp designates at which the transaction was registered at the advertiser website
- toDate
string(required)Most recent UTC time stamp of the dataset. For transactions, the time stamp designates at which time the transaction was registered at the advertiser website
- transactionStatus
number(required)The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected
- orderId
string(optional)Advertiser order ID
- channelId
number(optional)Numerical ID of a channel
- paymentStatus
number(optional)Specifies what payment status of transaction should be included in the dataset. 1 = not invoiced, 2 = invoiced to advertiser, 3 = ready for payment, 4 = paid to partner
- uniqueId
string(optional)Unique ID of a transaction
Body
{
"fromDate": "2019-03-01T00:00:00+0200",
"toDate": "2019-03-01T23:59:59+0200",
"transactionStatus": 1,
"orderId": "4880538909",
"channelId": 1070058671,
"paymentStatus": 4,
"uniqueId": "25862d1e-dc51-4fb2-82ae-24b8533ef417"
}Schema
{
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "Oldest UTC time stamp of the dataset. For transactions, the time stamp designates at which the transaction was registered at the advertiser website"
},
"toDate": {
"type": "string",
"description": "Most recent UTC time stamp of the dataset. For transactions, the time stamp designates at which time the transaction was registered at the advertiser website"
},
"transactionStatus": {
"type": "number",
"description": "The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected"
},
"orderId": {
"type": "string",
"description": "Advertiser order ID"
},
"channelId": {
"type": "number",
"description": "Numerical ID of a channel"
},
"paymentStatus": {
"type": "number",
"description": "Specifies what payment status of transaction should be included in the dataset. 1 = not invoiced, 2 = invoiced to advertiser, 3 = ready for payment, 4 = paid to partner"
},
"uniqueId": {
"type": "string",
"description": "Unique ID of a transaction"
}
},
"required": [
"fromDate",
"toDate",
"transactionStatus"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"click": {
"adId": 26503038,
"adName": "980x120 summer sale",
"adType": "Image",
"channelId": 1062755777,
"channelName": "John's business blog",
"clickDate": "2018-01-01T00:00:00+0100",
"status": "Fresh"
},
"cost": 15,
"currency": "SEK",
"paymentStatus": 1,
"orderId": "abc123_xyz",
"orderValue": 1000,
"reasonText": "Already attributed to another source",
"transactionDate": "2018-01-31T23:59:59+0100",
"lastUpdated": "2018-02-03T14:23:14+0100",
"autoApprovalDate": "2018-05-31",
"transactionName": "Order new customer",
"transactionStatus": 5,
"uniqueId": "25862d1e-dc51-4fb2-82ae-24b8533ef417",
"device": "smartphone",
"operatingSystem": "android",
"geoLocation": "SE",
"productCategoryData": [
{
"categoryId": "widgets",
"categoryName": "Green widgets",
"orderValue": 1000,
"cost": 1200
}
]
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Update transactionPUT/advertiser/transactions/{?token}
Updates the status or order value of a pending transaction or open claim.
Example URI
- token
string(required) Example: D0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- orderId
string(required)Advertiser order ID
- transactionStatus
number(optional)The status of a transaction. 1 = approved, 2 = pending, 4 = open claim, 5 = rejected. The following status updates are allowed: 2 → 1 (approve a pending transaction) 2 → 5 (reject a pending transaction) 4 → 1 (approve an open claim) 4 → 5 (reject an open claim).
- orderValue
number(optional)The order value of a transaction
- productCategoryData
array(optional)If the transaction was tracked with product category tracking the updated order value needs to be specified by category.
Members- categoryId
string(optional)The ID of a product category.
- orderValue
number(optional)The order value associated with a product category
Body
{
"orderId": "abcd123",
"transactionStatus": 1,
"orderValue": 1000,
"productCategoryData": [
{
"categoryId": "widgets",
"orderValue": 1000
}
]
}Schema
{
"type": "object",
"properties": {
"orderId": {
"type": "string",
"description": "Advertiser order ID"
},
"transactionStatus": {
"type": "number",
"description": "The status of a transaction. 1 = approved, 2 = pending, 4 = open claim, 5 = rejected. The following status updates are allowed: 2 → 1 (approve a pending transaction) 2 → 5 (reject a pending transaction) 4 → 1 (approve an open claim) 4 → 5 (reject an open claim). "
},
"orderValue": {
"type": "number",
"description": "The order value of a transaction"
},
"productCategoryData": {
"type": "array",
"items": {
"type": "object",
"properties": {
"categoryId": {
"type": "string",
"description": "The ID of a product category."
},
"orderValue": {
"type": "number",
"description": "The order value associated with a product category"
}
}
},
"description": "If the transaction was tracked with product category tracking the updated order value needs to be specified by category. "
}
},
"required": [
"orderId"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: close- success
boolean(optional)True or false
Body
{
"success": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "True or false"
}
}
}Segments ¶
List segmentsGET/advertiser/segments/{?token}
Returns the commission segments in your partner program, as well as the partner channels assigned to each segment.
Example URI
- token
string(required) Example: D0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8200Headers
X-RateLimit-Limit: 10
X-RateLimit-Remaining: 9
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"segmentName": "Gold",
"segmentId": 1400627353,
"channels": [
{
"channelId": 1175982945,
"channelName": "John's business blog"
}
]
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Coupons ¶
Add couponPUT/advertiser/coupon/{?token}
Assigns a unique coupon code to a specified channel, which allows the code to be used for coupon code tracking.
Example URI
- token
string(required) Example: D0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- code
string(required)A unique coupon code
- channelId
number(required)Numerical ID of a partner channel
- toDate
string(required)The last date the code will be valid for purchase, in ISO 8601 date format
- cookieTrack
boolean(optional)Decides if cookie tracking should be active for this channel (true) (default) or if only coupon code tracking should be used (false) during the time the coupon code is valid
Body
{
"code": "summerdiscount",
"channelId": 1086130254,
"toDate": "2022-05-23",
"cookieTrack": true
}Schema
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "A unique coupon code"
},
"channelId": {
"type": "number",
"description": "Numerical ID of a partner channel"
},
"toDate": {
"type": "string",
"description": "The last date the code will be valid for purchase, in ISO 8601 date format"
},
"cookieTrack": {
"type": "boolean",
"description": "Decides if cookie tracking should be active for this channel (true) (default) or if only coupon code tracking should be used (false) during the time the coupon code is valid"
}
},
"required": [
"code",
"channelId",
"toDate"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: close- success
boolean(optional)True or false
Body
{
"success": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "True or false"
}
}
}Statistics ¶
The Adtraction system tracks ad impressions, clicks, transactions and the corresponding commission for each channel in your partner program.
Retrieve statisticsPOST/advertiser/statistics/{?token}
Returns the aggregation of statistics across a defined time period.
Example URI
- token
string(required) Example: D0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- fromDate
string(required)The start date of the requested range in ISO 8601 date format
- toDate
string(required)The end date of the requested range in ISO 8601 date format
- transactionStatus
number(required)The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected
Body
{
"fromDate": "2018-05-17",
"toDate": "2018-05-23",
"transactionStatus": 1
}Schema
{
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "The start date of the requested range in ISO 8601 date format"
},
"toDate": {
"type": "string",
"description": "The end date of the requested range in ISO 8601 date format"
},
"transactionStatus": {
"type": "number",
"description": "The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected"
}
},
"required": [
"fromDate",
"toDate",
"transactionStatus"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: close- clicks
number(optional)Number of clicks
- clicksUnique
number(optional)Number of unique clicks
- cost
number(optional)The total cost of the transaction, including partner commission and platform fee
- impressions
number(optional)Number of banner / links impressions
- impressionsUnique
number(optional)Number of unique banner / links impressions
- orderValue
number(optional)Order value of the sale transactions
- leads
number(optional)Number of lead transactions
- sales
number(optional)Number of sale transactions
- ctr
number(optional)Click Through Ratio, obtained by dividing clicks by impressions
- leadRatio
number(optional)Lead Ratio, obtained by dividing leads by clicksUnique
- conversionRatio
number(optional)Conversion Ratio, obtained by dividing sales by clicksUnique
- aov
number(optional)Average order value, obtained by dividing order value by number of sale transactions
Body
{
"clicks": 150,
"clicksUnique": 100,
"cost": 600,
"impressions": 1500,
"impressionsUnique": 1300,
"orderValue": 1000.1,
"leads": 20,
"sales": 10,
"ctr": 0.06666,
"leadRatio": 0.021,
"conversionRatio": 0.032,
"aov": 100.87
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"clicks": {
"type": "number",
"description": "Number of clicks"
},
"clicksUnique": {
"type": "number",
"description": "Number of unique clicks"
},
"cost": {
"type": "number",
"description": "The total cost of the transaction, including partner commission and platform fee"
},
"impressions": {
"type": "number",
"description": "Number of banner / links impressions"
},
"impressionsUnique": {
"type": "number",
"description": "Number of unique banner / links impressions"
},
"orderValue": {
"type": "number",
"description": "Order value of the sale transactions"
},
"leads": {
"type": "number",
"description": "Number of lead transactions"
},
"sales": {
"type": "number",
"description": "Number of sale transactions"
},
"ctr": {
"type": "number",
"description": "Click Through Ratio, obtained by dividing clicks by impressions"
},
"leadRatio": {
"type": "number",
"description": "Lead Ratio, obtained by dividing leads by clicksUnique"
},
"conversionRatio": {
"type": "number",
"description": "Conversion Ratio, obtained by dividing sales by clicksUnique"
},
"aov": {
"type": "number",
"description": "Average order value, obtained by dividing order value by number of sale transactions"
}
}
}Statistics by ad ¶
Retrieve statistics by adPOST/advertiser/statistics/ads/{?token}
Returns the aggregation of statistics, grouped by ad, across a defined time period.
Example URI
- token
string(required) Example: D0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- fromDate
string(required)The start date of the requested range in ISO 8601 date format
- toDate
string(required)The end date of the requested range in ISO 8601 date format
- transactionStatus
number(required)The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected
- channelId
number(optional)Numerical ID of a partner channel
Body
{
"fromDate": "2018-05-17",
"toDate": "2018-05-23",
"transactionStatus": 1,
"channelId": 1086130254
}Schema
{
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "The start date of the requested range in ISO 8601 date format"
},
"toDate": {
"type": "string",
"description": "The end date of the requested range in ISO 8601 date format"
},
"transactionStatus": {
"type": "number",
"description": "The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected"
},
"channelId": {
"type": "number",
"description": "Numerical ID of a partner channel"
}
},
"required": [
"fromDate",
"toDate",
"transactionStatus"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"adId": 1062755777,
"adName": "980x120 summer sale",
"clicks": 150,
"clicksUnique": 100,
"cost": 600,
"impressions": 1500,
"impressionsUnique": 1300,
"orderValue": 1000.1,
"leads": 20,
"sales": 10,
"ctr": 0.06666,
"leadRatio": 0.021,
"conversionRatio": 0.032,
"aov": 100.87
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Statistics by channel ¶
Retrieve statistics by channelPOST/advertiser/statistics/channels/{?token}
Returns the aggregation of statistics, grouped by channel, across a defined time period.
Example URI
- token
string(required) Example: D0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- fromDate
string(required)The start date of the requested range in ISO 8601 date format
- toDate
string(required)The end date of the requested range in ISO 8601 date format
- transactionStatus
number(required)The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected
Body
{
"fromDate": "2018-05-17",
"toDate": "2018-05-23",
"transactionStatus": 1
}Schema
{
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "The start date of the requested range in ISO 8601 date format"
},
"toDate": {
"type": "string",
"description": "The end date of the requested range in ISO 8601 date format"
},
"transactionStatus": {
"type": "number",
"description": "The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected"
}
},
"required": [
"fromDate",
"toDate",
"transactionStatus"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"channelId": 1062755777,
"channelName": "John's business blog",
"channelType": "Blog",
"clicks": 150,
"clicksUnique": 100,
"cost": 600,
"impressions": 1500,
"impressionsUnique": 1300,
"orderValue": 1000.1,
"leads": 20,
"sales": 10,
"ctr": 0.06666,
"leadRatio": 0.021,
"conversionRatio": 0.032,
"aov": 100.87
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Statistics by day ¶
Retrieve statistics by dayPOST/advertiser/statistics/days/{?token}
Returns the aggregation of statistics, grouped by day, across a defined time period.
Example URI
- token
string(required) Example: D0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- fromDate
string(required)The start date of the requested range in ISO 8601 date format
- toDate
string(required)The end date of the requested range in ISO 8601 date format
- transactionStatus
number(required)The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected
- channelId
number(optional)Numerical ID of a channel
Body
{
"fromDate": "2018-05-17",
"toDate": "2018-05-23",
"transactionStatus": 1,
"channelId": 1175982945
}Schema
{
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "The start date of the requested range in ISO 8601 date format"
},
"toDate": {
"type": "string",
"description": "The end date of the requested range in ISO 8601 date format"
},
"transactionStatus": {
"type": "number",
"description": "The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected"
},
"channelId": {
"type": "number",
"description": "Numerical ID of a channel"
}
},
"required": [
"fromDate",
"toDate",
"transactionStatus"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
X-RateLimit-Limit: 10
X-RateLimit-Remaining: 9
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"date": "2018-05-17",
"clicks": 150,
"clicksUnique": 100,
"cost": 600,
"impressions": 1500,
"impressionsUnique": 1300,
"orderValue": 1000.1,
"leads": 20,
"sales": 10,
"ctr": 0.06666,
"leadRatio": 0.021,
"conversionRatio": 0.032,
"aov": 100.87
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Statistics by segment ¶
Retrieve statistics by segmentPOST/advertiser/statistics/segments/{?token}
Returns the aggregation of statistics, grouped by commission segment, across a defined time period.
Example URI
- token
string(required) Example: D0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8- fromDate
string(required)The start date of the requested range in ISO 8601 date format
- toDate
string(required)The end date of the requested range in ISO 8601 date format
- transactionStatus
number(required)The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected
Body
{
"fromDate": "2018-05-17",
"toDate": "2018-05-23",
"transactionStatus": 1
}Schema
{
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "The start date of the requested range in ISO 8601 date format"
},
"toDate": {
"type": "string",
"description": "The end date of the requested range in ISO 8601 date format"
},
"transactionStatus": {
"type": "number",
"description": "The status of the transactions to be included in the dataset. Impressions and clicks are not affected by this input. 1 = approved, 2 = pending, 3 = approved + pending, 4 = open claims, 5 = rejected"
}
},
"required": [
"fromDate",
"toDate",
"transactionStatus"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: 1565602012124
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"segmentId": 1104616062,
"segmentName": "Gold",
"clicks": 150,
"clicksUnique": 100,
"cost": 600,
"impressions": 1500,
"impressionsUnique": 1300,
"orderValue": 1000.1,
"leads": 20,
"sales": 10,
"ctr": 0.06666,
"leadRatio": 0.021,
"conversionRatio": 0.032,
"aov": 100.87
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Public ¶
Public endpoints do not require authentication. This allows you to use them in, for example, JavaScript widgets without exposing your private API token.
Products ¶
The Adtraction product database holds data such as price, images and links for products sold by advertisers on the Adtraction platform.
Find productsPOST/public/products/
Searches the Adtraction product database. Meta data is available in the response header, where count is the total number of products found for the specified search query, maxprice is the highest price found, and minprice is the lowest price found.
The search function is not case sensitive. The following operators can be used in the keyword field to modify your search:
AND signifies AND operation. Search for X and Y. This will return only results related to both X and Y.
OR signifies OR operation. Search for X or Y. This will return results related to X or Y, or both.
- excludes a term or phrase.
" wraps a number of words to signify a phrase for searching.
* at the end of a term signifies a wildcard query.
( and ) signify precedence.
AND discounted:true will include only products where productPrice is lower than oldPrice.
Examples:
Phrase match:
{"keyword": "\"Nivea Shower Creme Care 250 ml\"", "page": 0, "pageSize": 10}
Phrase match with wildcard:
{"keyword": "\"Nivea shower*\"", "page": 0, "pageSize": 10}
Exclude a term:
{"keyword": "Nivea -shower", "page": 0, "pageSize": 10}
AND operation
{"keyword": "Nivea AND shower", "page": 0, "pageSize": 10}
OR operation
{"keyword": "Nivea OR shower", "page": 0, "pageSize": 10}
You can speed up your query significantly by specifying what fields to search in the database.
The following fields can be searched individually: productPrice, productUrl, currency, programId, ean, sku, imageUrl, inStock, manufacturer, manufacturerArticleNumber, market, oldPrice, productCategory, productDescription, shipping.
Example:
Search for 1334868914 in the sku field only:
{"keyword": "sku:1334868914", "page": 0, "pageSize": 1}
Search meta data:
Each response includes header parameters with information about the results data set.
| Header name | Description |
|---|---|
| count | The number of products in the results dataset. |
| maxprice | The highest price of all the products in the results dataset. |
| minprice | The highest price of all the products in the results dataset. |
Example URI
Headers
Content-Type: application/json;charset=UTF-8- keyword
string(required)Search keyword. Matches against all output fields.
- page
number(required)The specified result page in the paginated response. The first page in the response is number 0.
- pageSize
number(required)Number of products to return on each page of a paginated result
- channelId
number(required)Numerical ID of a channel
- programId
string(optional)Numerical ID of one or several partner programs. Comma separated.
- market
string(optional)Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code
- currency
string(optional)Currency in ISO 4217 format
- inStock
boolean(optional)Only return products that are (or are not) in stock
- minPrice
number(optional)Only show products with a price of at least minPrice
- maxPrice
number(optional)Only show products with a price of at most maxPrice
- sort
string(optional)Determines the sort order. The value of this parameter is a comma-separated list of sort keys. Sort directions ‘asc’ or ‘desc’ can optionally be appended to each sort key, separated by the ‘:’ character. Available keys are: productPrice, programId, inStock, manufacturerArticleNumber, ean.
Body
{
"keyword": "macadamia",
"page": 0,
"pageSize": 10,
"channelId": 1175982945,
"programId": "1117786218,462891022",
"market": "SE",
"currency": "SEK",
"inStock": true,
"minPrice": 50,
"maxPrice": 250,
"sort": "programId,productPrice:desc"
}Schema
{
"type": "object",
"properties": {
"keyword": {
"type": "string",
"description": "Search keyword. Matches against all output fields."
},
"page": {
"type": "number",
"description": "The specified result page in the paginated response. The first page in the response is number 0."
},
"pageSize": {
"type": "number",
"description": "Number of products to return on each page of a paginated result"
},
"channelId": {
"type": "number",
"description": "Numerical ID of a channel"
},
"programId": {
"type": "string",
"description": "Numerical ID of one or several partner programs. Comma separated."
},
"market": {
"type": "string",
"description": "Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code"
},
"currency": {
"type": "string",
"description": "Currency in ISO 4217 format"
},
"inStock": {
"type": "boolean",
"description": "Only return products that are (or are not) in stock"
},
"minPrice": {
"type": "number",
"description": "Only show products with a price of at least minPrice"
},
"maxPrice": {
"type": "number",
"description": "Only show products with a price of at most maxPrice"
},
"sort": {
"type": "string",
"description": "Determines the sort order. The value of this parameter is a comma-separated list of sort keys. Sort directions 'asc' or 'desc' can optionally be appended to each sort key, separated by the ':' character. Available keys are: productPrice, programId, inStock, manufacturerArticleNumber, ean. "
}
},
"required": [
"keyword",
"page",
"pageSize",
"channelId"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
count: 178
page: 0
pageSize: 10
keyword: jeans
maxprice: 2499.0
minprice: 10.0
manufacturers: "Emporio Armani"
productCategories: "apparel & accessories - clothing - underwear & socks - underwear"
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"productName": "PlayStation 4",
"productPrice": "129.5",
"productUrl": "https://www.site.com/store/product_acb",
"currency": "EUR",
"programId": 1062755777,
"ean": "0711719437215",
"sku": "abc123",
"extraInfo": [
{
"key": "color",
"value": "red"
}
],
"imageUrl": "http://www.site.com/store/product_acb.png",
"inStock": true,
"manufacturer": "Sony",
"manufacturerArticleNumber": "12345678",
"market": "SE",
"oldPrice": 45,
"productCategory": "Consoles",
"productDescription": "PlayStation 4 redefines rich and immersive gameplay with powerful graphics and speed.",
"shipping": 9
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Compare loans ¶
Retrieve comparison data for loansPOST/public/compare/loans/
This endpoint is deprecated. Please use the Datafeeds endpoints available in your Adtraction account instead.
Retrieve data for loans.
NB: data will only be returned for programs that the specified channel is approved for.
Example URI
Headers
Content-Type: application/json;charset=UTF-8- channelId
number(required)Numerical ID of a channel
- currency
string(required)Currency in ISO 4217 format
- market
string(required)Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code
- programId
array(optional)A range of numerical IDs of partner programs. Programs will be returned in the order specified in the input.
- minAmount
number(optional)Only show loans for an amount of at least minAmount
- maxAmount
number(optional)Only show loans for an amount of at most maxAmount
- acceptsRemarks
boolean(optional)Only return lenders that accept (or do not accept) payment remarks
Body
{
"channelId": 49326900,
"currency": "EUR",
"market": "SE",
"programId": [
42014357,
1035156879
],
"minAmount": 5000,
"maxAmount": 100000,
"acceptsRemarks": true
}Schema
{
"type": "object",
"properties": {
"channelId": {
"type": "number",
"description": "Numerical ID of a channel"
},
"currency": {
"type": "string",
"description": "Currency in ISO 4217 format"
},
"market": {
"type": "string",
"description": "Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code"
},
"programId": {
"type": "array",
"items": {
"type": "number"
},
"description": "A range of numerical IDs of partner programs. Programs will be returned in the order specified in the input."
},
"minAmount": {
"type": "number",
"description": "Only show loans for an amount of at least minAmount"
},
"maxAmount": {
"type": "number",
"description": "Only show loans for an amount of at most maxAmount"
},
"acceptsRemarks": {
"type": "boolean",
"description": "Only return lenders that accept (or do not accept) payment remarks"
}
},
"required": [
"channelId",
"currency",
"market"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"programName": "Ferratum SE",
"programId": 679911480,
"programUrl": "https://www.ferratum.se",
"market": "SE",
"currency": "EUR",
"logoUrl": "https://secure.adtraction.com/image.htm?imgId=56807831",
"trackingUrl": "https://track.adtraction.com/t/t?a=24209996&as=24577691&t=2&tk=1",
"minAmount": 5000,
"maxAmount": 600000,
"minDuration": 1,
"maxDuration": 15,
"minInterest": 6.99,
"maxInterest": 22.99,
"minEffectiveInterest": 7.2,
"maxEffectiveInterest": 29.27,
"minAge": 20,
"minIncomeRequired": 110000,
"adminFee": 250,
"startFee": 399,
"firstLoanFree": false,
"timeUnit": "Year",
"acceptsRemarks": true,
"loanExample": "For a loan of SEK 65,000 laid out over five years with the example interest rate 13.99% (effective interest rate of 15.88%), the total amount to be paid is SEK 91,866, which corresponds to SEK 1,531 / month. Loan period 1-15 years. Max. effective interest rate 29.27%"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Compare payday loans ¶
Retrieve comparison data for payday loansPOST/public/compare/paydayloans/
This endpoint is deprecated. Please use the Datafeeds endpoints available in your Adtraction account instead.
Retrieve data for payday loans, which typically are consumer loans for smaller amounts with shorter duration than ordinary loans.
NB: data will only be returned for programs that the specified channel is approved for.
Example URI
Headers
Content-Type: application/json;charset=UTF-8- channelId
number(required)Numerical ID of a channel
- currency
string(required)Currency in ISO 4217 format
- market
string(required)Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code
- programId
array(optional)A range of numerical IDs of partner programs. Programs will be returned in the order specified in the input.
- minAmount
number(optional)Only show loans for an amount of at least minAmount
- maxAmount
number(optional)Only show loans for an amount of at most maxAmount
- acceptsRemarks
boolean(optional)Only return lenders that accept (or do not accept) payment remarks
Body
{
"channelId": 49326900,
"currency": "EUR",
"market": "SE",
"programId": [
42014357,
1035156879
],
"minAmount": 5000,
"maxAmount": 100000,
"acceptsRemarks": true
}Schema
{
"type": "object",
"properties": {
"channelId": {
"type": "number",
"description": "Numerical ID of a channel"
},
"currency": {
"type": "string",
"description": "Currency in ISO 4217 format"
},
"market": {
"type": "string",
"description": "Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code"
},
"programId": {
"type": "array",
"items": {
"type": "number"
},
"description": "A range of numerical IDs of partner programs. Programs will be returned in the order specified in the input."
},
"minAmount": {
"type": "number",
"description": "Only show loans for an amount of at least minAmount"
},
"maxAmount": {
"type": "number",
"description": "Only show loans for an amount of at most maxAmount"
},
"acceptsRemarks": {
"type": "boolean",
"description": "Only return lenders that accept (or do not accept) payment remarks"
}
},
"required": [
"channelId",
"currency",
"market"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"programName": "Ferratum SE",
"programId": 679911480,
"programUrl": "https://www.ferratum.se",
"market": "SE",
"currency": "EUR",
"logoUrl": "https://secure.adtraction.com/image.htm?imgId=56807831",
"trackingUrl": "https://track.adtraction.com/t/t?a=24209996&as=24577691&t=2&tk=1",
"minAmount": 5000,
"maxAmount": 600000,
"minDuration": 1,
"maxDuration": 15,
"minInterest": 6.99,
"maxInterest": 22.99,
"minEffectiveInterest": 7.2,
"maxEffectiveInterest": 29.27,
"minAge": 20,
"minIncomeRequired": 110000,
"adminFee": 250,
"startFee": 399,
"firstLoanFree": false,
"timeUnit": "Year",
"acceptsRemarks": true,
"loanExample": "For a loan of SEK 65,000 laid out over five years with the example interest rate 13.99% (effective interest rate of 15.88%), the total amount to be paid is SEK 91,866, which corresponds to SEK 1,531 / month. Loan period 1-15 years. Max. effective interest rate 29.27%"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Compare telecom deals ¶
Retrieve comparison data for telecom dealsPOST/public/compare/telecom/
This endpoint is deprecated. Please use the Datafeeds endpoints available in your Adtraction account instead.
Retrieve data for telecom deals.
NB: data will only be returned for programs that the specified channel is approved for.
Example URI
Headers
Content-Type: application/json;charset=UTF-8- channelId
number(required)Numerical ID of a channel
- currency
string(required)Currency in ISO 4217 format
- market
string(required)Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code
- programId
array(optional)A range of numerical IDs of partner programs. Programs will be returned in the order specified in the input.
Body
{
"channelId": 49326900,
"currency": "EUR",
"market": "SE",
"programId": [
42014357,
1035156879
]
}Schema
{
"type": "object",
"properties": {
"channelId": {
"type": "number",
"description": "Numerical ID of a channel"
},
"currency": {
"type": "string",
"description": "Currency in ISO 4217 format"
},
"market": {
"type": "string",
"description": "Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code"
},
"programId": {
"type": "array",
"items": {
"type": "number"
},
"description": "A range of numerical IDs of partner programs. Programs will be returned in the order specified in the input."
}
},
"required": [
"channelId",
"currency",
"market"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: closeBody
[
{
"offerTitle": "Acme 4G and 5G",
"offerDescription": "High speed 4G and 5G subscription with unlimited internet, messaging and phone calls.",
"programName": "Telecom SE",
"programId": 679911480,
"programUrl": "https://www.telecom.se",
"market": "SE",
"currency": "EUR",
"logoUrl": "https://secure.adtraction.com/image.htm?imgId=56807831",
"trackingUrl": "https://track.adtraction.com/t/t?a=24209996&as=24577691&t=2&tk=1",
"highlights": [
"This is a highlight"
],
"timeUnit": "Year",
"minutesLimit": 500,
"mobileDataLimit": 250,
"price": 99,
"priceBefore": 150,
"fixedTermPeriod": 6,
"startFee": 100,
"smsPrice": 2,
"minutePrice": 1.5,
"mbPrice": 0.5,
"roaming": true,
"mustPurchasePhone": true,
"4g": true,
"5g": true
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Exclusive coupon code ¶
If an advertiser has provided you with exclusive coupon codes specific to your channel, you have the ability to retrieve these codes individually.
Retrieve exclusive coupon codeGET/public/coupon/{programId}/{channelId}/{uniqueId}{?token}
Retrieves an exclusive coupon code for a specified program and channel. You will need to input a unique ID for each code.
Example URI
- programId
number(required) Example: 52561763Numerical ID of a partner program
- channelId
number(optional) Example: 1175982945Numerical ID of a channel
- uniqueId
string(optional) Example: abc123Your unique ID
- token
string(required) Example: E0E6BF3556DB0D83C8B401EBACBD6F1B0670633EYour Adtraction API token
Headers
Content-Type: application/json;charset=UTF-8200Headers
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: close- coupon
string(optional)An exclusive coupon code
- validTo
string(optional)The last date the coupon code will be valid for purchase, in ISO 8601 date format
Body
{
"coupon": "summerdiscount",
"validTo": "2023-11-04"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"coupon": {
"type": "string",
"description": "An exclusive coupon code"
},
"validTo": {
"type": "string",
"description": "The last date the coupon code will be valid for purchase, in ISO 8601 date format"
}
}
}Tracking link ¶
Retrieve tracking linkPOST/public/tracking/link/
Retrieves an Adtraction tracking link for a specified program and channel.
Example URI
Headers
Content-Type: application/json;charset=UTF-8- channelId
number(required)Numerical ID of a channel
- programId
number(required)Numerical ID of a partner program
- shortLink
boolean(optional)If set to true, the output will be a short link instead of a traditional tracking link
- url
string(optional)URL to the web page you want to link to. Must include protocol (“http:” or “https:”) and be located on the advertiser’s domain.
- epi
string(optional)EPI value to be inserted into the tracking link
- epi2
string(optional)EPI2 value to be inserted into the tracking link
- epi3
string(optional)EPI3 value to be inserted into the tracking link
- epi4
string(optional)EPI4 value to be inserted into the tracking link
- epi5
string(optional)EPI5 value to be inserted into the tracking link
Body
{
"channelId": 24577691,
"programId": 52561763,
"shortLink": false,
"url": "https://www.stayhard.se/skor",
"epi": "banner top right",
"epi2": "lorem",
"epi3": "ipsum",
"epi4": "dolor",
"epi5": "amet"
}Schema
{
"type": "object",
"properties": {
"channelId": {
"type": "number",
"description": "Numerical ID of a channel"
},
"programId": {
"type": "number",
"description": "Numerical ID of a partner program"
},
"shortLink": {
"type": "boolean",
"description": "If set to true, the output will be a short link instead of a traditional tracking link"
},
"url": {
"type": "string",
"description": "URL to the web page you want to link to. Must include protocol (\"http:\" or \"https:\") and be located on the advertiser's domain."
},
"epi": {
"type": "string",
"description": "EPI value to be inserted into the tracking link"
},
"epi2": {
"type": "string",
"description": "EPI2 value to be inserted into the tracking link"
},
"epi3": {
"type": "string",
"description": "EPI3 value to be inserted into the tracking link"
},
"epi4": {
"type": "string",
"description": "EPI4 value to be inserted into the tracking link"
},
"epi5": {
"type": "string",
"description": "EPI5 value to be inserted into the tracking link"
}
},
"required": [
"channelId",
"programId"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}200Headers
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 12 Aug 2019 09:25:52 GMT
Connection: close- trackingUrl
string(optional)Click tracking link for a specified channel and partner program, where “a” is the adId and “as” is the channelId.
Body
{
"trackingUrl": "https://track.adtraction.com/t/t?a=52561789&as=24577691&t=2&tk=1&url=https://www.stayhard.se/skor"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"trackingUrl": {
"type": "string",
"description": "Click tracking link for a specified channel and partner program, where \"a\" is the adId and \"as\" is the channelId."
}
}
}