Adtraction API v3
Adtraction API v3
This is the full documentation for the Adtraction API, version 3.
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.
If you have any questions regarding the API, feel free to contact support@adtraction.com.
API url
The base url for all API version 3 endpoints is https://api.adtraction.net/v3/
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 availablepageSize- the number of results per page to returnpage- 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 hour. |
| 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
List 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 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.
Parameters
| Name | Type | Description | |
|---|---|---|---|
| programId | number | required | Numerical ID of the partner program |
| channelId | number | optional | Numerical ID of a channel |
Response 200 array[Commissiontypes]
Try it
Set the values below, then edit the request if needed.
Request editable
Retrieve product feed
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.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| programId | number | required | Numerical ID of a partner program |
| channelId | number | required | Numerical ID of a channel |
| feedId | number | optional | Numerical ID of a product feed |
| setEpi | boolean | optional | If set to true, the epi will be set to the product name in tracking urls |
| gt | boolean | optional | Should be set to true if tracking links included in the product feed should comply with with the Transparent Click Tracker requirements in Google Ads. |
Response 200 array[Productfeed]
Try it
Request editable
Retrieve product feed information
Retrieves information about the products feeds available for a specific advertiser, including number of available products, last updated status and link to download the data file.
Parameters
| Name | Type | Description | |
|---|---|---|---|
| programId | number | required | Numerical ID of an partner program |
| channelId | number | required | Numerical ID of a channel |
Response 200 array[Channels]
Try it
Set the values below, then edit the request if needed.
Request editable
Retrieve program information
Each advertiser on the Adtraction platform has their 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.
Retrieves information about partner programs available on the Adtraction platform.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| market | string | required | 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 an partner program |
| channelId | number | optional | Numerical ID of a channel |
| approvalStatus | number | optional | Approval status for a partner program: 0 = rejected, 1 = approved, 2 = pending review |
| status | number | The status of the partner program on the Adtraction platform, where Live = 0 and Closing = 3 |
Response 200 array[Programs]
Try it
Request editable
Client
List 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.
Lists all channels that have applied to your program.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 |
Response 200 array[ChannelsClient]
Try it
Request editable
Update channel status
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.
Update the approval status for a channel in your program. Status can be updated to rejected (0) or approved (1).
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| channelId | number | optional | Numerical ID of a channel. |
| approvalStatus | number | optional | Approval status of a channel for a partner program: 0 = rejected, 1 = approved |
| rejectReason | number | optional | Required when approvalStatus is changed to: 0. The reason for rejecting the program application, where: 0 = Not enough content/posts, 1 = Not relevant content, 2 = A closed site/group/account, 3 = 404 on site, 4 = Site does not exist, 5 = Wrong contact details / shady details, 6 = Unethical content, 7 = Incorrect site owner, 8 = Missing info about the channel. No URL/link, 9 = To few followers/visitors, 10 = Poor design, 11 = Traffic is not relevant. 12 = Outdated content |
Response 200 Resp_v3_client_channels_put
Try it
Request editable
Data structures
Categories
| Property | Type | Description |
|---|---|---|
| category | string | Name of the product category |
| type | string | Type of commission, where % means percentage of order value and a currency in ISO 4217 format means a fixed amount. |
| value | number | The size of the commission |
Channels
| Property | Type | Description |
|---|---|---|
| feedId | number | The unique ID of the product feed in the Adtraction system |
| name | string | The name of the product feed in the Adtraction system |
| approvalStatus | number | Approval status of a specified channel for a partner program: 0 = rejected, 1 = approved, 2 = pending review, 3 = not applied |
| feedUrl | string | 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 | UTC time stamp of when file was last updated |
| numberOfProducts | number | Number of products included in the file |
ChannelsClient
| Property | Type | Description |
|---|---|---|
| affiliateId | number | Numerical ID of a partner account. |
| affiliateName | string | Name of the partner. Individual or company. |
| channelId | number | Numerical ID of a channel. |
| channelName | string | Name of a channel. |
| channelDescription | string | A description of a channel. |
| channelUrl | string | The URL of a channel, if applicable. |
| channelType | string | The type of a channel, such as Blog, Content, Facebook, Cashback, etc. |
| approvalStatus | number | Approval status of a channel for a partner program: 0 = rejected, 1 = approved, 2 = pending review |
| applicationDate | string | The date when the channel first applied to join your program. |
| rejectReason | number | Available when approvalStatus is set to: 0. The reason for the program application being rejected, where: 0 = Not enough content/posts, 1 = Not relevant content, 2 = A closed site/group/account, 3 = 404 on site, 4 = Site does not exist, 5 = Wrong contact details / shady details, 6 = Unethical content, 7 = Incorrect site owner, 8 = Missing info about the channel. No URL/link, 9 = To few followers/visitors, 10 = Poor design, 11 = Traffic is not relevant. 12 = Outdated content |
| reasonText | string | Available when approvalStatus is set to: 0. The reason for the program application being rejected. |
Programs
| Property | Type | Description |
|---|---|---|
| programId | number | Numerical ID of the partner program. |
| market | string | Geographical market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code |
| currency | string | The currency used for the program. ISO 4217 format |
| approvalStatus | number | Approval status for a partner program. Only available when channelId is provided as input and when an application has been made by the channelId to the programId. 0 = rejected, 1 = approved, 2 = pending review |
| ppcMarketing | number | Rules for Pay Per Click Marketing (Google Adwords, etc), where: 0 = not allowed,1 = allowed, 2 = restricted (no brand bidding) |
| socialMarketing | number | Rules for Social Media Marketing (Facebook, etc), where: 0 = not allowed, 1 = allowed |
| emailMarketing | number | Rules for Email Marketing, where: 0 = not allowed, 1 = allowed, 2 = restricted (preview is required) |
| cashbackMarketing | number | Rules for cashback / reward partners: 0 = not allowed, 1 = allowed |
| couponMarketing | number | Advertising rules for voucher / coupon partners, where: 0 = not allowed, 1 = allowed |
| programName | string | Name of the partner program |
| programURL | string | Main URL for a specified partner program |
| currentSegment | string | The commission segment the specified channel currently belongs to in the specified partner program. Only available when channelId is provided as input. |
| pendingActive | boolean | Set to true if the advertiser reviews transactions manually. Transactions will have status Pending until they are approved or rejected by the advertiser |
| cookieDuration | number | Number of days after each click during which transactions are tracked |
| adId | number | Numerical ID of the ad. When using /partner/programs/ the adId provided is equal to the programAdId for each partner program. Use this as the parameter 'a' in your tracking links |
| commissions | array[Commissiontypes] | Array containing the name, value and type of all currently active commissions types in a partner program |
| feeds | array[Feeds] | Information about product data feeds provided by the advertiser. Only available when channelId is provided and approvalStatus = 1. |
| logoURL | string | URL of the advertiser logo image file |
| trackingURL | string | Default click tracking URL for a specified channel and partner program, where "a" is the adId and "as" is the channelId. Only available when channelId is provided as input and approvalStatus is "1" (approved). |
| categoryName | string | The name of the category that the partner program belongs to on the Adtraction platform |
| categoryId | number | Numerical ID of the category that the partner program belongs to on the Adtraction platform |
| trackingType | number | The type of tracking the advertiser has implemented where 1 or 5 = first-party cookie tracking, 2 = server-to-server tracking, 3 = legacy cookie tracking, 4 = dedicated subdomain tracking |
| status | number | The status of the partner program on the Adtraction platform, where Live = 0 and Closing = 3 |
| epc | number | EPC (Earnings Per Click) is a measurement of the average amount that partners earn every time they direct a click to a partner program. It serves as an indicator of the profitability of each program, and is determined by averaging the EPC for all channels active on the program, excluding the top and bottom 5 %. |
Commissiontypes
| Property | Type | Description |
|---|---|---|
| id | string | Numerical ID of the commission type |
| type | string | Type of commission. Absolute (EUR, for example) or a percentage of order value (%) |
| name | string | Name of the commission type |
| value | number | Commission offered |
| transactionType | number | Specifies the type of the transaction where: 3 = Sale, 4 = Lead |
| categories | array[Categories] | Information about differentiated commission levels in different product categories, if applicable. |
| thresholds | array[Thresholds] | Information about differentiated commission levels for different order values, if applicable. |
Feeds
| Property | Type | Description |
|---|---|---|
| feedUrl | string | The URL from which the data file can be downloaded. 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 | Date when the product data file was last updated |
| numberOfProducts | number | Number of products included in the product data file |
| feedId | number | Numerical ID of the product data file |
| name | string | Name of the product dat file |
Productfeed
| Property | Type | Description |
|---|---|---|
| productName | string | Name of the product |
| productPrice | string | Online price for the product, including VAT, excluding delivery cost |
| productUrl | string | URL to the product page on the advertiser website. |
| trackingUrl | string | URL to the product page on the advertiser website. |
| currency | string | Currency in ISO 4217 format |
| programId | number | Numerical ID of the partner program |
| approvalStatus | number | Approval status of a specified channel for a partner program: 0 = rejected, 1 = approved, 2 = pending review, 3 = not applied |
| ean | string | European Article Number (13 digit) |
| sku | string | Unique product ID. |
| extraInfo | array[ProductExtrainfo] | Any extra data available, such a size, gender, color |
| imageUrl | string | The image URL to associate with the product. |
| inStock | boolean | Only return products that are (or are not) in stock |
| manufacturer | string | The name of the manufacturer |
| manufacturerArticleNumber | string | The article number from the manufacturer |
| market | string | Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code |
| oldPrice | number | The previous price of the product. Can be used to display the product as on sale |
| productCategory | string | Product category on the advertiser website |
| productDescription | string | Description of the product |
| shipping | number | Cost of delivery |
ProductExtrainfo
| Property | Type | Description |
|---|---|---|
| key | string | A unique identifier for a type of product data that is provided by some advertisers in addition to the standard set of data required by Adtraction. |
| value | string | The value associated with a key |
Thresholds
| Property | Type | Description |
|---|---|---|
| orderValue | number | The minimum order value that must be attained for a commission level to apply. |
| type | string | Identifies the type of commmission, where a percentage symbol (%) denotes a proportion of the order value, while a currency represented in the ISO 4217 format signifies a fixed amount. |
| value | number | The size of the commission. |
Adtraction API v2
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 support@adtraction.com.
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 availablepageSize- the number of results per page to returnpage- 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
List markets
Adtraction offers partner programs on several geographical markets.
Lists the markets on which Adtraction offers partner programs.
Response 200 array[Markets]
Try it
Request editable
List approved 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.
Lists all the approved channels in your partner account.
Parameters
| Name | Type | Description | |
|---|---|---|---|
| channelId | number | optional | Numerical ID of a channel |
Response 200 array[Channels]
Try it
Set the values below, then edit the request if needed.
Request editable
List currencies
Lists all active currencies on the Adtraction platform.
Response 200 Resp_v2_partner_currencies_get
Try it
Request editable
List 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.
Lists the status of all your applications to partner programs.
Parameters
| Name | Type | Description | |
|---|---|---|---|
| programId | number | optional | Numerical ID of a partner program |
| channelId | number | optional | Numerical ID of a channel |
Response 200 array[Applications]
Try it
Set the values below, then edit the request if needed.
Request editable
Retrieve program information
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.
This endpoint is deprecated. Please use API version 3.
Retrieves information about partner programs available on the Adtraction platform.
Parameters
| Name | Type | Description | |
|---|---|---|---|
| market | string | required | 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 a partner program |
| channelId | number | optional | Numerical ID of a channel |
| approvalStatus | number | optional | Approval status for a partner program: 0 = rejected, 1 = approved, 2 = pending review |
Response 200 array[Programs]
Try it
Set the values below, then edit the request if needed.
Request editable
List program categories
All partner programs on the Adtraction platform belong to a specific category, such as Banking & Finance or Family & Kids.
Lists all program categories and the number of partner programs currently available in each category.
Parameters
| Name | Type | Description | |
|---|---|---|---|
| marketId | number | required | Numerical ID of a geographical market |
Response 200 array[Categories]
Try it
Set the values below, then edit the request if needed.
Request editable
Retrieve program directory
List all programs with their associated category.
Parameters
| Name | Type | Description | |
|---|---|---|---|
| marketId | number | optional | Numerical ID of a geographical market |
| categoryId | number | optional | Numerical ID of the category |
Response 200 Resp_v2_partner_program_directory_get
Try it
Set the values below, then edit the request if needed.
Request editable
List 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.
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.
Parameters
| Name | Type | Description | |
|---|---|---|---|
| programId | number | required | Numerical ID of the partner program |
| channelId | number | optional | Numerical ID of a channel |
Response 200 array[Commissiontypes]
Try it
Set the values below, then edit the request if needed.
Request editable
List new programs
Lists partner programs recently added to the Adtraction platform. Programs are normally classified as new for up to 30 days.
Parameters
| Name | Type | Description | |
|---|---|---|---|
| marketId | number | required | Numerical ID of a geographical market |
Response 200 array[Newprograms]
Try it
Set the values below, then edit the request if needed.
Request editable
Find products
The Adtraction product database holds data such as price, images and links for products sold by advertisers on the Adtraction platform.
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:
| Operator | Description |
|---|---|
AND | AND operation — search for X and Y. Returns only results related to both X and Y. |
OR | OR operation — search for X or Y. Returns results related to X, 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. |
( ) | Signify precedence. |
AND discounted:true | Includes only products where productPrice is lower than oldPrice. |
Examples
| Use case | Request body |
|---|---|
| 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 which 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 dataset.
| 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 lowest price of all the products in the results dataset. |
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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. |
Response 200 array[Products]
Try it
Request editable
Retrieve product feed
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.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 |
Response 200 array[Productfeed]
Try it
Request editable
Retrieve product feed information
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.
Parameters
| Name | Type | Description | |
|---|---|---|---|
| programId | number | required | Numerical ID of a partner program |
| channelId | number | required | Numerical ID of a channel |
Response 200 Resp_v2_partner_product_feed_info_get
Try it
Set the values below, then edit the request if needed.
Request editable
List coupons and offers
Lists coupon codes, vouchers and offers available for partner programs on the Adtraction platform.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 |
Response 200 array[Coupons]
Try it
Request editable
List clicks
Lists clicks tracked in your account during a specified time period.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 | EPI2 extracted from the tracking link that generated the click | |
| epi3 | string | EPI3 extracted from the tracking link that generated the click | |
| epi4 | string | EPI4 extracted from the tracking link that generated the click | |
| epi5 | string | EPI5 extracted from the tracking link that generated the click | |
| wbraid | string | Extracted from the tracking link that generated the click | |
| gbraid | string | Extracted from the tracking link that generated the click | |
| gclid | string | Google Click ID. |
Response 200 array[Clicks]
Try it
Request editable
List transactions
Events that generate commissions are tracked in your Adtraction account.
Lists transactions tracked in your account during a specified time period.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 |
Response 200 array[Transaction]
Try it
Request editable
List transactions in a payment
Lists transactions included in a specified payment generated in your Adtraction account.
Parameters
| Name | Type | Description | |
|---|---|---|---|
| paymentId | number | required | Numerical ID of a payment in your Adtraction account |
Response 200 array[TransactionInPayment]
Try it
Set the values below, then edit the request if needed.
Request editable
List transactions with gclid
Lists transactions with a gclid (Google Click ID) value tracked in your account during a specified time period.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 |
Response 200 array[Transaction]
Try it
Request editable
Retrieve gclid transactions report
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.
Response 200
Try it
Request editable
List latest transactions
Lists the latest transactions tracked in your account where transactionStatus = 1 (approved) or transactionStatus = 2 (pending).
Parameters
| Name | Type | Description | |
|---|---|---|---|
| number | number | optional | Number of transactions to retrieve. Defaults to 10 if not specified |
Response 200 array[Transaction]
Try it
Set the values below, then edit the request if needed.
Request editable
Create claim
Creates a claim for an untracked transaction. The commissionId can be obtained by using /partner/programs/commissions.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 | EPI2 value for the transaction | |
| epi3 | string | EPI3 value for the transaction | |
| epi4 | string | EPI4 value for the transaction | |
| epi5 | string | EPI5 value for the transaction |
Response 200 Resp_v2_partner_claims_put
Try it
Request editable
Retrieve statistics
The Adtraction system tracks ad impressions, clicks, transactions and the corresponding commission for each channel and partner program.
Returns the aggregation of statistics across a defined time period.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 |
Response 200 Statistics
Try it
Request editable
Retrieve statistics by ad
Returns the aggregation of statistics, grouped by ad, across a defined time period.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 |
Response 200 array[StatisticsByAd]
Try it
Request editable
Retrieve statistics by channel
Returns the aggregation of statistics, grouped by channel, across a defined time period.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 |
Response 200 array[StatisticsByChannel]
Try it
Request editable
Retrieve statistics by day
Returns the aggregation of statistics, grouped by day, across a defined time period.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 |
Response 200 array[StatisticsByDay]
Try it
Request editable
Retrieve statistics by EPI
Returns the aggregation of statistics, grouped by EPI values, across a defined time period.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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. |
Response 200 Resp_v2_partner_statistics_by_epi_post
Try it
Request editable
Retrieve statistics by program
Returns the aggregation of statistics, grouped by program, across a defined time period.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 |
Response 200 array[StatisticsByProgram]
Try it
Request editable
Retrieve commission by type
Returns the aggregation of commission earned across a defined time period, grouped by type.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 |
| 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 |
Response 200 Resp_v2_partner_commission_by_type_post
Try it
Request editable
Retrieve commission by payment status
Returns the aggregation of commission earned across a defined time period, grouped by payment status.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 | 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 |
Response 200 Paymentstatus
Try it
Request editable
Retrieve commission by transaction status
Returns the aggregation of commission earned across a defined time period, grouped by transaction status.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 | 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 |
Response 200 Transactionstatus
Try it
Request editable
Retrieve account balance
Commission earned from advertisers on the Adtraction platform will accumulate in the account balance in your Adtraction account.
Retrieves your account balance for a specified currency (ISO 4217).
Parameters
| Name | Type | Description | |
|---|---|---|---|
| currency | string | required | Currency in ISO 4217 format |
Response 200 Resp_v2_partner_account_balance_get
Try it
Set the values below, then edit the request if needed.
Request editable
List payments
Commission earned from advertisers on the Adtraction platform will be paid on a monthly basis.
Lists payments generated in you Adtraction account.
Parameters
| Name | Type | Description | |
|---|---|---|---|
| currency | string | optional | Currency in ISO 4217 format. Only payments in the specified currency will be included in the dataset |
| paymentId | number | optional | Numerical ID of a payment generated in your Adtraction account |
Response 200 array[Payments]
Try it
Set the values below, then edit the request if needed.
Request editable
Retrieve payment specification PDF
Each payment generated in your Adtractions account will have a specifiction in PDF format.
Downloads a specified payment specification in PDF format.
Parameters
| Name | Type | Description | |
|---|---|---|---|
| paymentId | number | required | Numerical ID of a payment generated in your Adtraction account |
Response 200
Try it
Set the values below, then edit the request if needed.
Request editable
List tracking errors
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.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| channelId | number | optional | Numerical ID of a channel |
| programId | number | optional | Numerical ID of a partner program |
Response 200 array[Trackingerrors]
Try it
Request editable
Retrieve tracking link
Retrieves an Adtraction tracking link for a specified program and channel.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 | EPI value to be inserted into the tracking link | |
| epi2 | string | EPI2 value to be inserted into the tracking link | |
| epi3 | string | EPI3 value to be inserted into the tracking link | |
| epi4 | string | EPI4 value to be inserted into the tracking link | |
| epi5 | string | EPI5 value to be inserted into the tracking link |
Response 200 Resp_v2_partner_tracking_link_post
Try it
Request editable
Advertiser
Account details
Returns details about your Adtraction advertiser account.
Response 200 Resp_v2_advertiser_account_get
Try it
Request editable
List 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.
This endpoint is deprecated. Please use API version 3.
Lists all channels that have applied to your program.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 |
Response 200 array[ChannelsAdvertiser]
Try it
Request editable
Update channel status
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.
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).
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| channelId | number | optional | Numerical ID of a channel. |
| approvalStatus | number | optional | Approval status of a channel for a partner program: 0 = rejected, 1 = approved |
Response 200 Resp_v2_advertiser_channels_put
Try it
Request editable
List clicks
Lists clicks tracked in your account during a specified time period. NB: clicks older than 14 months are not available.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 |
Response 200 array[AdvertiserClicks]
Try it
Request editable
List transactions
Events that generate commission are tracked in your Adtraction account.
Lists transactions tracked in your account during a specified time period.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 |
Response 200 array[TransactionAdvertiser]
Try it
Request editable
Update transaction
Events that generate commission are tracked in your Adtraction account.
Updates the status or order value of a pending transaction or open claim.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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[putProductCategoryData] | If the transaction was tracked with product category tracking the updated order value needs to be specified by category. |
Response 200 Resp_v2_advertiser_transactions_put
Try it
Request editable
List segments
Returns the commission segments in your partner program, as well as the partner channels assigned to each segment.
Response 200 array[Segments]
Try it
Request editable
Add coupon
Assigns a unique coupon code to a specified channel, which allows the code to be used for coupon code tracking.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 |
Response 200 Resp_v2_advertiser_coupons_put
Try it
Request editable
Retrieve statistics
The Adtraction system tracks ad impressions, clicks, transactions and the corresponding commission for each channel in your partner program.
Returns the aggregation of statistics across a defined time period.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 |
Response 200 StatisticsAdvertiser
Try it
Request editable
Retrieve statistics by ad
Returns the aggregation of statistics, grouped by ad, across a defined time period.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 |
Response 200 array[StatisticsAdvertiserAds]
Try it
Request editable
Retrieve statistics by channel
Returns the aggregation of statistics, grouped by channel, across a defined time period.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 |
Response 200 array[StatisticsAdvertiserChannels]
Try it
Request editable
Retrieve statistics by day
Returns the aggregation of statistics, grouped by day, across a defined time period.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 |
Response 200 array[StatisticsAdvertiserDays]
Try it
Request editable
Retrieve statistics by segment
Returns the aggregation of statistics, grouped by commission segment, across a defined time period.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 |
Response 200 array[StatisticsAdvertiserSegments]
Try it
Request editable
Public
Find products
The Adtraction product database holds data such as price, images and links for products sold by advertisers on the Adtraction platform.
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:
| Operator | Description |
|---|---|
AND | AND operation — search for X and Y. Returns only results related to both X and Y. |
OR | OR operation — search for X or Y. Returns results related to X, 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. |
( ) | Signify precedence. |
AND discounted:true | Includes only products where productPrice is lower than oldPrice. |
Examples
| Use case | Request body |
|---|---|
| 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 which 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 dataset.
| 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 lowest price of all the products in the results dataset. |
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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. |
Response 200 array[Products]
Try it
Request editable
Retrieve comparison data for 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.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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[number] | 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 |
Response 200 array[LoansCompareOutput]
Try it
Request editable
Retrieve comparison data for payday loans
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.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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[number] | 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 |
Response 200 array[LoansCompareOutput]
Try it
Request editable
Retrieve comparison data for telecom deals
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.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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[number] | optional | A range of numerical IDs of partner programs. Programs will be returned in the order specified in the input. |
Response 200 array[TelecomCompareOutput]
Try it
Request editable
Retrieve 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.
Retrieves an exclusive coupon code for a specified program and channel. You will need to input a unique ID for each code.
Parameters
| Name | Type | Description | |
|---|---|---|---|
| programId | number | required | Numerical ID of a partner program |
| channelId | number | optional | Numerical ID of a channel |
| uniqueId | string | optional | Your unique ID |
Response 200 Resp_v2_public_exclusive_coupon_code_get
Try it
Set the values below, then edit the request if needed.
Request editable
Retrieve tracking link
Retrieves an Adtraction tracking link for a specified program and channel.
Body attributes
| Name | Type | Description | |
|---|---|---|---|
| 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 | EPI value to be inserted into the tracking link | |
| epi2 | string | EPI2 value to be inserted into the tracking link | |
| epi3 | string | EPI3 value to be inserted into the tracking link | |
| epi4 | string | EPI4 value to be inserted into the tracking link | |
| epi5 | string | EPI5 value to be inserted into the tracking link |
Response 200 Resp_v2_public_tracking_link_post
Try it
Request editable
Data structures
Paymentstatus
| Property | Type | Description |
|---|---|---|
| paymentstatus | PaymentstatusDetails |
PaymentstatusDetails
| Property | Type | Description |
|---|---|---|
| 1 | number | Not invoiced |
| 2 | number | Invoiced to advertiser |
| 3 | number | Ready for payment |
| 4 | number | Paid to partner |
Transactionstatus
| Property | Type | Description |
|---|---|---|
| transactionstatus | TransactionstatusDetails |
TransactionstatusDetails
| Property | Type | Description |
|---|---|---|
| 1 | number | Approved |
| 2 | number | Pending |
| 4 | number | Open claims |
| 5 | number | Rejected |
LoansCompareInput
| Property | Type | Description |
|---|---|---|
| channelId | number | Numerical ID of a channel |
| currency | string | Currency in ISO 4217 format |
| market | string | Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code |
| programId | array[number] | A range of numerical IDs of partner programs. Programs will be returned in the order specified in the input. |
| minAmount | number | Only show loans for an amount of at least minAmount |
| maxAmount | number | Only show loans for an amount of at most maxAmount |
| acceptsRemarks | boolean | Only return lenders that accept (or do not accept) payment remarks |
TelecomCompareInput
| Property | Type | Description |
|---|---|---|
| channelId | number | Numerical ID of a channel |
| currency | string | Currency in ISO 4217 format |
| market | string | Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code |
| programId | array[number] | A range of numerical IDs of partner programs. Programs will be returned in the order specified in the input. |
LoansCompareOutput
| Property | Type | Description |
|---|---|---|
| programName | string | Name of a partner program |
| programId | number | Numerical ID of a partner program |
| programUrl | string | Main URL for a partner program |
| market | string | ISO 3166-1 Alpha-2 country code |
| currency | string | Currency in ISO 4217 format |
| logoUrl | string | URL of the advertiser logo image file |
| trackingUrl | string | Click tracking URL for the program |
| minAmount | number | Minimum loan amount allowed |
| maxAmount | number | Maximum loan amount allowed |
| minDuration | number | Minimum loan duration allowed. Expressed in days, months or years as defined by the timeUnit attribute. |
| maxDuration | number | Maximum loan duration allowed. Expressed in days, months or years as defined by the timeUnit attribute. |
| minInterest | number | Minimum nominal interest rate of the loan |
| maxInterest | number | Maximum nominal interest rate of the loan |
| minEffectiveInterest | number | Minimum effective interest rate of the loan |
| maxEffectiveInterest | number | Maximum effective interest rate of the loan |
| minAge | number | Minimum age required by the lender |
| minIncomeRequired | number | Minimum annual income required by the lender |
| adminFee | number | Monthly admin fee charged by the lender, if any |
| startFee | number | Starting fee charged by the lender, if any |
| firstLoanFree | boolean | Whether the lender provides the first loan for free |
| timeUnit | string | Time unit used for the minDuration and maxDuration attributes (Year, Month or Day) |
| acceptsRemarks | boolean | Whether the lender accepts (or does not accept) payment remarks |
| loanExample | string | An example showing the costs associated with the loan |
TelecomCompareOutput
| Property | Type | Description |
|---|---|---|
| offerTitle | string | A brief title describing the offer |
| offerDescription | string | Description of the offer |
| programName | string | Name of a partner program |
| programId | number | Numerical ID of a partner program |
| programUrl | string | Main URL for a partner program |
| market | string | ISO 3166-1 Alpha-2 country code |
| currency | string | Currency in ISO 4217 format |
| logoUrl | string | URL of the advertiser logo image file |
| trackingUrl | string | Click tracking URL for the offer |
| highlights | array[string] | Highlights describing the offer. Can number from 0 to 3. |
| timeUnit | string | Time unit used for the price and priceBefore attributes (Year or Month) |
| minutesLimit | number | The monthly limit in minutes for telephone calls |
| mobileDataLimit | number | The monthly data transfer limit in MB |
| price | number | The price of the deal per Year or Month, as defined by the timeUnit attribute |
| priceBefore | number | The earlier price of the deal per Year or Month, as defined by the timeUnit attribute |
| fixedTermPeriod | number | How many months the customer must stay with the company before they can change to another service provider |
| startFee | number | Starting fee |
| smsPrice | number | Price per SMS message |
| minutePrice | number | Price per minute for telephone calls |
| mbPrice | number | Price per MB data transfer |
| roaming | boolean | Set to true if roaming is included |
| mustPurchasePhone | boolean | Set to true if the company requires the customer to purchase the handset as a part of the deal |
| 4g | boolean | Set to true if 4G access is included |
| 5g | boolean | Set to true if 5G access is included |
Markets
| Property | Type | Description |
|---|---|---|
| market | string | ISO 3166-1 Alpha-2 country code |
| marketName | string | Market name |
| marketId | number | Numerical Adtraction ID of the market |
Segments
| Property | Type | Description |
|---|---|---|
| segmentName | string | The name of the segment |
| segmentId | number | Numerical Adtraction ID of the segment |
| channels | array[Channellist] |
Categories
| Property | Type | Description |
|---|---|---|
| categoryName | string | Name of the category |
| categoryId | number | Numerical ID of the category |
| numberOfPrograms | number | Number of partner programs currently available in the cateogry |
Channels
| Property | Type | Description |
|---|---|---|
| channelId | number | Numerical ID of a channel |
| channelName | string | Name of a channel |
| channelUrl | string | The URL of a channel, if applicable. |
| channelType | string | The type of a channel, such as Blog, Content, Facebook, Cashback, etc. |
Channellist
| Property | Type | Description |
|---|---|---|
| channelId | number | Numerical ID of a channel |
| channelName | string | Name of a channel |
Applications
| Property | Type | Description |
|---|---|---|
| channelId | number | Numerical ID of a channel |
| channelName | string | Name of a partner channel |
| status | number | Status of the channel's application for the specified program. 0 = rejected, 1 = approved, 2 = pending |
| programId | number | Numerical ID of a partner program |
| programName | string | Name of a partner program |
| categoryName | string | Name of the category the program belongs to |
| categoryId | number | Numerical ID of the category the program belongs to |
Ads
| Property | Type | Description |
|---|---|---|
| adId | number | Numerical ID of a banner or link |
| adName | string | Name of a banner or link |
| adType | string | Type of banner or link |
| trackingUrl | string | Click tracking URL for the ad. Only available when channelId is provided as input and the channel is approved for the program. |
Coupons
| Property | Type | Description |
|---|---|---|
| logoURL | string | URL of the advertiser logo image file |
| market | string | Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code |
| offerCoupon | string | Coupon code that can be redeemed for a financial discount or rebate when purchasing a product from a specified advertiser on the Adtraction platform |
| offerDescription | string | Description of the financial discount or rebate available through the offer or coupon code |
| offerId | string | Unique identifier for the offer |
| offerPage | string | The URL to the page on the advertiser's website where information about a discount or an offer can be found |
| offerTerms | string | Terms that apply in order for a coupon code or offer to be valid |
| offerType | string | Type of offer where: 1 = coupon code, 2 = offer (no coupon required) |
| programId | number | Numerical ID of the partner program |
| programName | string | Name of the partner program |
| programUrl | string | Main URL for a specified partner program |
| trackingURL | string | Default click tracking URL for a specified channel and partner program. Only returned when channelId is provided as input and the channel is approved for the program |
| validFrom | string | UTC time stamp of when the coupon code or offer starts being valid |
| validTo | string | UTC time stamp of when the coupon code or offer expires |
| lastUpdated | string | UTC time stamp of when the coupon code or offer was last updated |
| createdDate | string | UTC time stamp of when the coupon code or offer was created |
| categoryId | number | Numerical ID of the category the partner program belongs to on the Adtraction platform |
Commissiontypes
| Property | Type | Description |
|---|---|---|
| id | string | Numerical ID of the commission type |
| type | string | Type of commission. Absolute (EUR, for example) or a percentage of order value (%) |
| name | string | Name of the commission type |
| value | number | Commission offered |
| transactionType | number | Specifies the type of the transaction where: 3 = Sale, 4 = Lead |
ProductExtrainfo
| Property | Type | Description |
|---|---|---|
| key | string | A unique identifier for a type of product data that is provided by some advertisers in addition to the standard set of data required by Adtraction. |
| value | string | The value associated with a key |
Products
| Property | Type | Description |
|---|---|---|
| productName | string | Name of the product |
| productPrice | string | Online price for the product, including VAT, excluding delivery cost |
| productUrl | string | URL to the product page on the advertiser website. |
| currency | string | Currency in ISO 4217 format |
| programId | number | Numerical ID of the partner program |
| ean | string | European Article Number (13 digit) |
| sku | string | Unique product ID. |
| extraInfo | array[ProductExtrainfo] | Any extra data available, such a size, gender, color |
| imageUrl | string | The image URL to associate with the product. |
| inStock | boolean | Only return products that are (or are not) in stock |
| manufacturer | string | The name of the manufacturer |
| manufacturerArticleNumber | string | The article number from the manufacturer |
| market | string | Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code |
| oldPrice | number | The previous price of the product. Can be used to display the product as on sale |
| productCategory | string | Product category on the advertiser website |
| productDescription | string | Description of the product |
| shipping | number | Cost of delivery |
Productfeed
| Property | Type | Description |
|---|---|---|
| productName | string | Name of the product |
| productPrice | string | Online price for the product, including VAT, excluding delivery cost |
| productUrl | string | URL to the product page on the advertiser website. |
| trackingUrl | string | URL to the product page on the advertiser website. |
| currency | string | Currency in ISO 4217 format |
| programId | number | Numerical ID of the partner program |
| approvalStatus | number | Approval status of a specified channel for a partner program: 0 = rejected, 1 = approved, 2 = pending review, 3 = not applied |
| ean | string | European Article Number (13 digit) |
| sku | string | Unique product ID. |
| extraInfo | array[ProductExtrainfo] | Any extra data available, such a size, gender, color |
| imageUrl | string | The image URL to associate with the product. |
| inStock | boolean | Only return products that are (or are not) in stock |
| manufacturer | string | The name of the manufacturer |
| manufacturerArticleNumber | string | The article number from the manufacturer |
| market | string | Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code |
| oldPrice | number | The previous price of the product. Can be used to display the product as on sale |
| productCategory | string | Product category on the advertiser website |
| productDescription | string | Description of the product |
| shipping | number | Cost of delivery |
Click
| Property | Type | Description |
|---|---|---|
| adId | number | Numerical ID of an ad |
| adName | string | Name of banner or link |
| adType | string | Type of banner or link |
| channelId | number | Numerical ID of a channel. Your Channel IDs can be found by navigating to "Account" > "My channels" in your Adtraction account |
| channelName | string | Name of a channel |
| clickDate | string | UTC timestamp of the click that generated the transaction |
| programId | number | Numerical ID of a partner program |
| programName | string | Name of a partner program |
| market | string | Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code |
| status | string | Current status of the click, where Fresh means still in cookie duration and Stale means outside cookie duration. |
| epi | string | EPI extracted from the tracking link that generated the click |
| epi2 | string | EPI2 extracted from the tracking link that generated the click |
| epi3 | string | EPI3 extracted from the tracking link that generated the click |
| epi4 | string | EPI4 extracted from the tracking link that generated the click |
| epi5 | string | EPI5 extracted from the tracking link that generated the click |
| wbraid | string | Extracted from the tracking link that generated the click |
| gbraid | string | Extracted from the tracking link that generated the click |
| gclid | string | Google Click ID. Extracted from the tracking link that generated the transaction |
| cid | string | Google Anlytics Client ID. Extracted from the tracking link that generated the transaction |
Clicks
| Property | Type | Description |
|---|---|---|
| adId | number | Numerical ID of an ad |
| adName | string | Name of banner or link |
| adType | string | Type of banner or link |
| channelId | number | Numerical ID of a channel. Your Channel IDs can be found by navigating to "Account" > "My channels" in your Adtraction account |
| clickDate | string | UTC timestamp of the click that generated the transaction |
| programId | number | Numerical ID of a partner program |
| programName | string | Name of a partner program |
| status | string | Current status of the click, where Fresh means still in cookie duration and Stale means outside cookie duration. |
| epi | string | EPI extracted from the tracking link that generated the click |
| epi2 | string | EPI2 extracted from the tracking link that generated the click |
| epi3 | string | EPI3 extracted from the tracking link that generated the click |
| epi4 | string | EPI4 extracted from the tracking link that generated the click |
| epi5 | string | EPI5 extracted from the tracking link that generated the click |
| wbraid | string | Extracted from the tracking link that generated the click |
| gbraid | string | Extracted from the tracking link that generated the click |
| gclid | string | Google Click ID. Extracted from the tracking link that generated the click |
| cid | string | Google Anlytics Client ID. Extracted from the tracking link that generated the click |
| currency | string | Currency in ISO 4217 format |
| commission | number | The partner commission for the click, if any. |
AdvertiserClicks
| Property | Type | Description |
|---|---|---|
| adId | number | Numerical ID of an ad |
| adName | string | Name of banner or link |
| adType | string | Type of banner or link |
| channelId | number | Numerical ID of a channel. Your Channel IDs can be found by navigating to "Account" > "My channels" in your Adtraction account |
| channelName | string | Name of a channel |
| clickDate | string | UTC timestamp of the click that generated the transaction |
| status | string | Current status of the click, where Fresh means still in cookie duration and Stale means outside cookie duration. |
Trackingerrors
| Property | Type | Description |
|---|---|---|
| channelId | number | Numerical ID of a channel |
| channelName | string | Name of a channel |
| programId | number | Numerical ID of a partner program |
| programName | string | Name of a partner program |
| actionDate | string | UTC timestamp of the action that triggered the error |
| actionType | string | Type of action that triggered the error. Impression or click |
| errorType | string | Description of the error |
| trackingUrl | string | The Adtration tracking URL that was used when the error was triggered |
| fallbackAction | number | The action performed due to a broken link. 31 = Redirected to plain Adtraction error page. 36 = Redirected to custom URL. 37 = Redirected to actual link destination. 40 = Fallback offers not available. Redirected to plain Adtraction error page. 41 = Fallback to original URL failed. Redirected to plain Adtraction error page. 42 = Redirected to fallback offers. |
| referer | string | HTTP referer for action that triggered the error. Not always available |
ClickAdvertiser
| Property | Type | Description |
|---|---|---|
| adId | number | Numerical ID of an ad |
| adName | string | Name of banner or link |
| adType | string | Type of banner or link |
| channelId | number | Numerical ID of a channel. Your Channel IDs can be found by navigating to "Account" > "My channels" in your Adtraction account |
| channelName | string | Name of a channel |
| clickDate | string | UTC timestamp of the click that generated the transaction |
| status | string | Current status of the click, where Fresh means still in cookie duration and Stale means outside cookie duration. |
Transaction
| Property | Type | Description |
|---|---|---|
| click | Click | Information about the click that preceeded the transaction |
| commission | number | The partner commission for the transaction. If the commission amount has been updated after the creation of the transaction, this parameter will hold the updated commission amount. |
| currency | string | Currency in ISO 4217 format |
| paymentStatus | number | 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 |
| orderValue | number | Order value of the transaction |
| originalCommission | number | Partner commission for the transaction. If the commission amount has been updated after the creation of the transaction, this parameter will hold the commission amount that existed before the update. |
| originalOrderValue | number | Advertiser order value for the transaction. If the order value has been updated after the creation of the transaction, this parameter will hold the order value that existed before the update. |
| reasonText | string | For rejected transactions (transactionStatus = 5) the advertiser can may choose to provide the reason for the transaction being rejected. |
| transactionDate | string | UTC timestamp of when the transaction was reported by the advertiser. |
| lastUpdated | string | UTC timestamp of when the transactionStatus or orderValue of the transaction was last updated. Only available for transactions where transactionStatus or orderValue has been updated. |
| autoApprovalDate | string | Date when a pending transaction (transactionStatus = 2) will be automatically approved unless already approved or rejected by the advertiser. |
| transactionName | string | Name of the transaction |
| transactionType | number | Specifies the type of the transaction where: 3 = Sale, 4 = Lead |
| transactionStatus | number | 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 |
| uniqueId | string | Unique ID for the transaction |
| device | string | The type of device that was used to complete the transaction |
| operatingSystem | string | The operating system used on the device that was used to complete the transaction |
| paymentId | number | Numerical ID of a payment in your Adtraction account. Available if the transaction has paymentStatus = 4 (paid to partner) and is included in a payment in your Adtraction account. |
| geoLocation | string | The geographic market where the transaction was completed, defined by an ISO 3166-1 Alpha-2 country code |
| productCategoryData | array[productCategoryDataPartner] | Holds the IDs, names, order values and commission of all product categories included in the transaction. Available only if the transaction was tracked with product category tracking. |
TransactionInPayment
| Property | Type | Description |
|---|---|---|
| click | Click | Information about the click that preceeded the transaction |
| commission | number | The partner commission for the transaction. If the commission amount has been updated after the creation of the transaction, this parameter will hold the updated commission amount. |
| currency | string | Currency in ISO 4217 format |
| paymentStatus | number | 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 |
| orderValue | number | Order value of the transaction |
| originalCommission | number | Partner commission for the transaction. If the commission amount has been updated after the creation of the transaction, this parameter will hold the commission amount that existed before the update. |
| originalOrderValue | number | Advertiser order value for the transaction. If the order value has been updated after the creation of the transaction, this parameter will hold the order value that existed before the update. |
| reasonText | string | For rejected transactions (transactionStatus = 5) the advertiser can may choose to provide the reason for the transaction being rejected. |
| transactionDate | string | UTC timestamp of when the transaction was reported by the advertiser. |
| lastUpdated | string | UTC timestamp of when the transactionStatus or orderValue of the transaction was last updated. Only available for transactions where transactionStatus or orderValue has been updated. |
| transactionName | string | Name of the transaction |
| transactionType | number | Specifies the type of the transaction where: 3 = Sale, 4 = Lead |
| transactionStatus | number | 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 |
| uniqueId | string | Unique ID for the transaction |
| device | string | The type of device that was used to complete the transaction |
| operatingSystem | string | The operating system used on the device that was used to complete the transaction |
| paymentId | number | Numerical ID of a payment in your Adtraction account, in which the transaction is included |
| geoLocation | string | The geographic market where the transaction was completed, defined by an ISO 3166-1 Alpha-2 country code |
| productCategoryData | array[productCategoryDataPartner] | Holds the IDs, names, order values and commission of all product categories included in the transaction. Available only if the transaction was tracked with product category tracking. |
TransactionAdvertiser
| Property | Type | Description |
|---|---|---|
| click | ClickAdvertiser | Information about the click that preceeded the transaction |
| cost | number | The cost of the transaction, including partner commission and Adtraction platform fee. |
| currency | string | Currency in ISO 4217 format |
| paymentStatus | number | 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 |
| orderId | string | Advertiser order ID |
| orderValue | number | Order value of the transaction |
| reasonText | string | For rejected transactions (transactionStatus = 5) you may choose to provide the reason for the transaction being rejected. |
| transactionDate | string | UTC timestamp of when the transaction was reported by the advertiser. |
| lastUpdated | string | UTC timestamp of when the transactionStatus or orderValue of the transaction was last updated. Only available for transactions where transactionStatus or orderValue has been updated. |
| autoApprovalDate | string | Date when a pending transaction (transactionStatus = 2) will be automatically approved unless already approved or rejected. |
| transactionName | string | Name of the transaction |
| transactionStatus | number | 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 |
| uniqueId | string | Unique ID for the transaction |
| device | string | The type of device that was used to complete the transaction |
| operatingSystem | string | The operating system used on the device that was used to complete the transaction |
| geoLocation | string | The geographic market where the transaction was completed, defined by an ISO 3166-1 Alpha-2 country code |
| productCategoryData | array[productCategoryData] | Holds the IDs, names, order values and cost of all product categories included in the transaction. Available only if the transaction was tracked with product category tracking. |
StatisticsInput
| Property | Type | Description |
|---|---|---|
| fromDate | string | The start date of the requested range in ISO 8601 date format |
| toDate | string | The end date of the requested range in ISO 8601 date format |
| currency | string | Currency in ISO 4217 format |
| market | string | Market defined by an ISO 3166-1 Alpha-2 country code |
| transactionStatus | number | 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 | Numerical ID of a partner program |
| channelId | number | Numerical ID of a partner channel |
StatisticsEPIInput
| Property | Type | Description |
|---|---|---|
| fromDate | string | The start date of the requested range in ISO 8601 date format |
| toDate | string | The end date of the requested range in ISO 8601 date format |
| currency | string | Currency in ISO 4217 format |
| market | string | Market defined by an ISO 3166-1 Alpha-2 country code |
| transactionStatus | number | 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 | Numerical ID of a partner program |
| channelId | number | Numerical ID of a partner channel |
| groupbyEpi | boolean | Determines whether the output should be grouped by the EPI attribute. Defaults to true. |
| groupbyEpi2 | boolean | Determines whether the output should be grouped by the EPI2 attribute. Defaults to false. |
| groupbyEpi3 | boolean | Determines whether the output should be grouped by the EPI3 attribute. Defaults to false. |
| groupbyEpi4 | boolean | Determines whether the output should be grouped by the EPI4 attribute. Defaults to false. |
| groupbyEpi5 | boolean | Determines whether the output should be grouped by the EPI5 attribute. Defaults to false. |
StatisticsInputAdvertiser
| Property | Type | Description |
|---|---|---|
| fromDate | string | The start date of the requested range in ISO 8601 date format |
| toDate | string | The end date of the requested range in ISO 8601 date format |
| transactionStatus | number | 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 |
CommissionInput
| Property | Type | Description |
|---|---|---|
| fromDate | string | The start date of the requested range in ISO 8601 date format |
| toDate | string | The end date of the requested range in ISO 8601 date format |
| currency | string | Currency in ISO 4217 format |
| transactionStatus | number | 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 | Market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code |
| programId | number | Numerical ID of a partner program |
| channelId | number | Numerical ID of a partner channel |
Programs
| Property | Type | Description |
|---|---|---|
| programId | number | Numerical ID of the partner program. |
| market | string | Geographical market on which a partner program is available, defined by an ISO 3166-1 Alpha-2 country code |
| currency | string | Currency in ISO 4217 format. Only transactions in the specified currency will be included in the dataset |
| approvalStatus | number | Approval status for a partner program. Only available when channelId is provided as input and when an application has been made by the channelId to the programId. 0 = rejected, 1 = approved, 2 = pending review |
| feed | boolean | Whether product feed is available |
| ppcMarketing | number | Rules for Pay Per Click Marketing (Google Adwords, etc), where: 0 = not allowed,1 = allowed, 2 = restricted (no brand bidding) |
| socialMarketing | number | Rules for Social Media Marketing (Facebook, etc), where: 0 = not allowed, 1 = allowed |
| emailMarketing | number | Rules for Email Marketing, where: 0 = not allowed, 1 = allowed, 2 = restricted (preview is required) |
| cashbackMarketing | number | Rules for cashback / reward partners: 0 = not allowed, 1 = allowed |
| couponMarketing | number | Advertising rules for voucher / coupon partners, where: 0 = not allowed, 1 = allowed |
| programName | string | Name of the partner program |
| programURL | string | Main URL for a specified partner program |
| currentSegment | string | The commission segment the specified channel currently belongs to in the specified partner program. Only available when channelId is provided as input. |
| pendingActive | boolean | Set to true if the advertiser reviews transactions manually. Transactions will have status Pending until they are approved or rejected by the advertiser |
| cookieDuration | number | Number of days after each click during which transactions are tracked |
| adId | number | Numerical ID of the ad. When using /partner/programs/ the adId provided is equal to the programAdId for each partner program. Use this as the parameter 'a' in your tracking links |
| commissions | array[commissions] | Array containing the name, value and type of all currently active commissions types in a partner program |
| feedURL | string | URL to download the advertiser data feed. Only available if feed is "true". 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) |
| logoURL | string | URL of the advertiser logo image file |
| trackingURL | string | Default click tracking URL for a specified channel and partner program, where "a" is the adId and "as" is the channelId. Only available when channelId is provided as input and approvalStatus is "1" (approved). |
| categoryName | string | The name of the category that the partner program belongs to on the Adtraction platform |
| trackingType | number | The type of tracking the advertiser has implemented where 1 or 5 = first-party cookie tracking, 2 = server-to-server tracking, 3 = legacy cookie tracking, 4 = dedicated subdomain tracking |
Newprograms
| Property | Type | Description |
|---|---|---|
| logoURL | string | URL of the advertiser logo image file |
| programName | string | The name of the partner program |
| categoryName | string | Name of the category that the partner program belongs to on the Adtraction platform |
| categoryId | number | Numerical ID of the category the program belongs to |
| sortorder | number | Order in which new programs are displayed on the partner dashboard in your Adtraction account |
| createdDate | string | UTC timestamp of when the program was added to the list of new programs |
| programId | number | Numerical ID of the partner program |
commissions
| Property | Type | Description |
|---|---|---|
| id | string | Name of the commission type |
| type | string | Type of commission. Absolute, for example SEK, or a percentage of order value |
| name | string | Name of the commission type |
| value | number | Commission offered |
| transactionType | number | Specifies the type of the transaction where: 3 = Sale, 4 = Lead |
Payments
| Property | Type | Description |
|---|---|---|
| currency | string | Currency in ISO 4217 format |
| exchangeRate | number | If the payment has been exchanged from one currency to another, this attribute will hold the exchange rate applied. Stated as the target currency amount divided by the original currency amount. |
| originalCurrency | string | If the payment has been exchanged from one currency to another, this attribute will hold the original currency in ISO 4217 format. |
| paymentdate | string | UTC timestamp of when the payment was sent from Adtraction |
| paymentId | number | Numerical ID of a payment generated in your Adtraction account |
| totalAmount | number | Total amount of the payment |
| taxAmount | number | Amount of tax deducted from the payment. Returned if your tax status is Swedish private individual. |
| vatAmount | number | Amount of VAT included in the payment. Returned if your tax status is corporation or a private individual residing outside Sweden. |
StatisticsAdvertiser
| Property | Type | Description |
|---|---|---|
| clicks | number | Number of clicks |
| clicksUnique | number | Number of unique clicks |
| cost | number | The total cost of the transaction, including partner commission and platform fee |
| impressions | number | Number of banner / links impressions |
| impressionsUnique | number | Number of unique banner / links impressions |
| orderValue | number | Order value of the sale transactions |
| leads | number | Number of lead transactions |
| sales | number | Number of sale transactions |
| ctr | number | Click Through Ratio, obtained by dividing clicks by impressions |
| leadRatio | number | Lead Ratio, obtained by dividing leads by clicksUnique |
| conversionRatio | number | Conversion Ratio, obtained by dividing sales by clicksUnique |
| aov | number | Average order value, obtained by dividing order value by number of sale transactions |
StatisticsAdvertiserChannels
| Property | Type | Description |
|---|---|---|
| channelId | number | Numerical ID of a channel |
| channelName | string | Name of a channel |
| channelType | string | The type of a channel, such as Blog, Content, Facebook, Cashback, etc. |
| clicks | number | Number of clicks |
| clicksUnique | number | Number of unique clicks |
| cost | number | The total cost of the transaction, including partner commission and platform fee |
| impressions | number | Number of banner / links impressions |
| impressionsUnique | number | Number of unique banner / links impressions |
| orderValue | number | Order value of the sale transactions |
| leads | number | Number of lead transactions |
| sales | number | Number of sale transactions |
| ctr | number | Click Through Ratio, obtained by dividing clicks by impressions |
| leadRatio | number | Lead Ratio, obtained by dividing leads by clicksUnique |
| conversionRatio | number | Conversion Ratio, obtained by dividing sales by clicksUnique |
| aov | number | Average order value, obtained by dividing order value by number of sale transactions |
StatisticsAdvertiserDays
| Property | Type | Description |
|---|---|---|
| date | string | Date in ISO 8601 date format |
| clicks | number | Number of clicks |
| clicksUnique | number | Number of unique clicks |
| cost | number | The total cost of the transaction, including partner commission and platform fee |
| impressions | number | Number of banner / links impressions |
| impressionsUnique | number | Number of unique banner / links impressions |
| orderValue | number | Order value of the sale transactions |
| leads | number | Number of lead transactions |
| sales | number | Number of sale transactions |
| ctr | number | Click Through Ratio, obtained by dividing clicks by impressions |
| leadRatio | number | Lead Ratio, obtained by dividing leads by clicksUnique |
| conversionRatio | number | Conversion Ratio, obtained by dividing sales by clicksUnique |
| aov | number | Average order value, obtained by dividing order value by number of sale transactions |
StatisticsAdvertiserAds
| Property | Type | Description |
|---|---|---|
| adId | number | Numerical ID of a banner or link |
| adName | string | Name of a banner or link |
| clicks | number | Number of clicks |
| clicksUnique | number | Number of unique clicks |
| cost | number | The total cost of the transaction, including partner commission and platform fee |
| impressions | number | Number of banner / links impressions |
| impressionsUnique | number | Number of unique banner / links impressions |
| orderValue | number | Order value of the sale transactions |
| leads | number | Number of lead transactions |
| sales | number | Number of sale transactions |
| ctr | number | Click Through Ratio, obtained by dividing clicks by impressions |
| leadRatio | number | Lead Ratio, obtained by dividing leads by clicksUnique |
| conversionRatio | number | Conversion Ratio, obtained by dividing sales by clicksUnique |
| aov | number | Average order value, obtained by dividing order value by number of sale transactions |
StatisticsAdvertiserSegments
| Property | Type | Description |
|---|---|---|
| segmentId | number | Numerical ID of a commission segment |
| segmentName | string | Name of a commission segment |
| clicks | number | Number of clicks |
| clicksUnique | number | Number of unique clicks |
| cost | number | The total cost of the transaction, including partner commission and platform fee |
| impressions | number | Number of banner / links impressions |
| impressionsUnique | number | Number of unique banner / links impressions |
| orderValue | number | Order value of the sale transactions |
| leads | number | Number of lead transactions |
| sales | number | Number of sale transactions |
| ctr | number | Click Through Ratio, obtained by dividing clicks by impressions |
| leadRatio | number | Lead Ratio, obtained by dividing leads by clicksUnique |
| conversionRatio | number | Conversion Ratio, obtained by dividing sales by clicksUnique |
| aov | number | Average order value, obtained by dividing order value by number of sale transactions |
Statistics
| Property | Type | Description |
|---|---|---|
| clicks | number | Number of clicks |
| clicksUnique | number | Number of unique clicks |
| commission | number | Amount of partner commission |
| currency | string | Currency in ISO 4217 format |
| impressions | number | Number of banner / links impressions |
| impressionsUnique | number | Number of unique banner / links impressions |
| leads | number | Number of lead transactions |
| sales | number | Number of sale transactions |
| orderValue | number | Order value of the sale transactions |
| epc | number | Earnings Per Click obtained by dividing the commission by clicksUnique |
| ctr | number | Click Through Ratio, obtained by dividing clicks by impressions |
| leadRatio | number | Lead Ratio, obtained by dividing leads by clicksUnique |
StatisticsByChannel
| Property | Type | Description |
|---|---|---|
| channelId | number | Numerical ID of a channel |
| channelName | string | Name of a channel |
| clicks | number | Number of clicks |
| clicksUnique | number | Number of unique clicks |
| commission | number | Amount of partner commission |
| currency | string | Currency in ISO 4217 format |
| impressions | number | Number of banner / links impressions |
| impressionsUnique | number | Number of unique banner / links impressions |
| leads | number | Number of lead transactions |
| sales | number | Number of sale transactions |
| orderValue | number | Order value of the sale transactions |
| epc | number | Earnings Per Click obtained by dividing the commission by clicksUnique |
| ctr | number | Click Through Ratio, obtained by dividing clicks by impressions |
| leadRatio | number | Lead Ratio, obtained by dividing leads by clicksUnique |
| conversionRatio | number | Conversion Ratio, obtained by dividing sales by clicksUnique |
StatisticsByDay
| Property | Type | Description |
|---|---|---|
| date | string | Date in ISO 8601 date format |
| clicks | number | Number of clicks |
| clicksUnique | number | Number of unique clicks |
| commission | number | Amount of partner commission |
| currency | string | Currency in ISO 4217 format |
| impressions | number | Number of banner / links impressions |
| impressionsUnique | number | Number of unique banner / links impressions |
| leads | number | Number of lead transactions |
| sales | number | Number of sale transactions |
| orderValue | number | Order value of the sale transactions |
| epc | number | Earnings Per Click obtained by dividing the commission by clicksUnique |
| ctr | number | Click Through Ratio, obtained by dividing clicks by impressions |
| leadRatio | number | Lead Ratio, obtained by dividing leads by clicksUnique |
| conversionRatio | number | Conversion Ratio, obtained by dividing sales by clicksUnique |
StatisticsByEpi
| Property | Type | Description |
|---|---|---|
| clicks | number | Number of clicks |
| clicksUnique | number | Number of unique clicks |
| commission | number | Amount of partner commission |
| currency | string | Currency in ISO 4217 format |
| leads | number | Number of lead transactions |
| sales | number | Number of sale transactions |
| orderValue | number | Order value of the sale transactions |
| epc | number | Earnings Per Click obtained by dividing the commission by clicksUnique |
| aov | number | Average order value, obtained by dividing order value by number of sale transactions |
| leadRatio | number | Lead Ratio, obtained by dividing leads by clicksUnique |
| conversionRatio | number | Conversion Ratio, obtained by dividing sales by clicksUnique |
StatisticsByProgram
| Property | Type | Description |
|---|---|---|
| programId | number | Numerical ID of a partner program |
| programName | string | Name of a partner program |
| clicks | number | Number of clicks |
| clicksUnique | number | Number of unique clicks |
| commission | number | Amount of partner commission |
| currency | string | Currency in ISO 4217 format |
| impressions | number | Number of banner / links impressions |
| impressionsUnique | number | Number of unique banner / links impressions |
| leads | number | Number of lead transactions |
| sales | number | Number of sale transactions |
| orderValue | number | Order value of the sale transactions |
| epc | number | Earnings Per Click obtained by dividing the commission by clicksUnique |
| ctr | number | Click Through Ratio, obtained by dividing clicks by impressions |
| leadRatio | number | Lead Ratio, obtained by dividing leads by clicksUnique |
| conversionRatio | number | Conversion Ratio, obtained by dividing sales by clicksUnique |
StatisticsByAd
| Property | Type | Description |
|---|---|---|
| adId | number | Numerical ID of a banner or link |
| adName | string | Name of a banner or link |
| clicks | number | Number of clicks |
| clicksUnique | number | Number of unique clicks |
| commission | number | Amount of partner commission |
| currency | string | Currency in ISO 4217 format |
| impressions | number | Number of banner / links impressions |
| impressionsUnique | number | Number of unique banner / links impressions |
| leads | number | Number of lead transactions |
| sales | number | Number of sale transactions |
| orderValue | number | Order value of the sale transactions |
| epc | number | Earnings Per Click obtained by dividing the commission by clicksUnique |
| ctr | number | Click Through Ratio, obtained by dividing clicks by impressions |
| leadRatio | number | Lead Ratio, obtained by dividing leads by clicksUnique |
| conversionRatio | number | Conversion Ratio, obtained by dividing sales by clicksUnique |
ChannelsAdvertiser
| Property | Type | Description |
|---|---|---|
| affiliateId | number | Numerical ID of a partner account. |
| affiliateName | string | Name of the partner. Individual or company. |
| channelId | number | Numerical ID of a channel. |
| channelName | string | Name of a channel. |
| channelDescription | string | A description of a channel. |
| channelUrl | string | The URL of a channel, if applicable. |
| channelType | string | The type of a channel, such as Blog, Content, Facebook, Cashback, etc. |
| approvalStatus | number | Approval status of a channel for a partner program: 0 = rejected, 1 = approved, 2 = pending review |
| applicationDate | string | The date when the channel first applied to join your program. |
productCategoryData
| Property | Type | Description |
|---|---|---|
| categoryId | string | The ID of a product category. |
| categoryName | string | The name of a product category. |
| orderValue | number | The order value associated with a product category. |
| cost | number | The cost associated with a product category, including partner commission and Adtraction platform fee. |
productCategoryDataPartner
| Property | Type | Description |
|---|---|---|
| categoryId | string | The ID of a product category. |
| categoryName | string | The name of a product category. |
| orderValue | number | The order value associated with a product category. |
| commission | number | The commission associated with a product category. |
putProductCategoryData
| Property | Type | Description |
|---|---|---|
| categoryId | string | The ID of a product category. |
| orderValue | number | The order value associated with a product category |
Generated from API Blueprint · ADTR-DOCS-2026-06-25