Apiary Powered Documentation
Sign in with Apiary account.
Tradedoubler is an Affiliate Marketing Network, connecting various advertising brands with our network of publishing websites. Tradedoubler's platform manages this relationship between advertisers and publishers. This documentation relates to the Advertiser API, which allows brands or advertisers to manage their programs on Tradedoubler's platform.
2021-08-19 Endpoints changed in this release:
GET /events
POST /events
PUT /events
When creating a lead or sale event, we automatically create a corresponding impression based event (i.e. for when there is no click we assign the conversion to an impression and then track using the referencing impression conversion event). We have added the referencing iLead or iSales event to leads and sales event.
Endpoints changed in this release:
GET /transactions
GET /transactions/export
GET /users/me
PUT /users/me
We have included an option to filter by datetime by adding time to toDate and fromDate, this can apply to timeOfTransaction or timeOfLastModified. Time is optional and if not supplied, we assume 00:00:00 for fromDate and 23:59:59 for toDate.
We have included an option to filter by datetime by adding time to toDate and fromDate, this can apply to timeOfTransaction or timeOfLastModified. Time is optional and if not supplied, we assume 00:00:00 for fromDate and 23:59:59 for toDate.
We have included an endpoint to update your account details.
All users can now specify their prefered currency, this will be used in the UI to default currency for dashboards and reports.
Endpoints changed in this release:
GET /transactions
GET /transactions/export
We have included an optional lastModified: When enabled, this applies the date range to the date the transaction was last modified rather than the time the of transaction.
We have included an optional lastModified: When enabled, this applies the date range to the date the transaction was last modified rather than the time the of transaction.
Endpoints changed in this release:
We have introduced a new endpoint which will close an existing program
Endpoints changed in this release:
GET /pendingSales
GET /programs/{programId}/sources
POST /programs/{programId}/commissions
We have improved performance on pendingSales endpoint, as a result we have removed the field "queuedForProcess"
We have added more meta data for program sources, this will help with validation of affiliate applications. The fields are: sourceUrl, promotionTypeId and promotionTypeName
We have fixed a bug where commissions could not be added for untracked sales events (event id 17)
Endpoints changed in this release:
We have added metrics for Unique Visitors, impression Leads and Impression Sales as well daily breakdown and commission for Impression Leads and Sales.
Authentication against the API is handled by oAuth 2.0 using bearer tokens. Once you have authentication using the oauth endpoint, all requests require a bearer token sent via the Authorization
header as per the following format:
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0ZHVzZXIiOiIzYWY2MDIyZDlmZjQ2NjcxNTEwOWY1OWQ2Yjc4MDI0YjI0NzA1Y2RiYzRhNDJkODkxMGNhNmZkYjBhN2RkNzE5ODJkNDdhNTQwN2FjNTQxYTAyZDczOTRmMmQxZmI5ODI1NTRhYjRjNWE2OTAyMjQ3NGEwZDczNDY5M2ZjMmEzMDgzYTI0MzBkYzI4OTU4ZDI2MmQ5OGZiOTBhYzk1Yjc3YTMyMmViOTM0NDdiMzFlMzY2YWU3ZTlmNzM0M2NmM2NhM2I5ZWVkNzQzYTc5Y2JmY2EyYzQzMmE0YWIxMGU5MTU2YzFlYzQxZTVmNzBjZmIwMzZiMDE5MmQ1ZTllYjQ5OGRmNzMzZDNlZWVmYTIxNDM4YjE2NGRhOTgyYjVjYmIxM2ZhMzgyMzY5NzlkZTllMTQwNWJhYTY0YWRjYmQzNTllZGM5NjcyZWVkY2MxN2IyMzY0MTU5ZmNkOWFmMzFhMDYyMWM2MmQwYzEyMGM0Y2YyOWFiNzAwYWRmNWYzMWI0YTNmN2M5NDgxNDE4M2UxM2YwODIwZmE0ZmFkMDM5NiIsInVzZXJfbmFtZSI6InVrQHRyYWRlZG91Ymxlci5jb20iLCJjcmVhdGVkIjoxNTQ5OTc3MDE3LCJzY29wZSI6WyJyZWFkIl0sImV4cCI6MTU0OTk3NzkxNywiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImp0aSI6IjA2OGU4YTllLTc4ZjUtNDdkNy1iMjU1LWU1YmZmZjExYWM4OCIsImNsaWVudF9pZCI6InRkY29ubmVjdF9wdWJsaXNoZXIifQ.cN_ose-fMtxGbVN27Yg2Sotc4zz4oLLVkyZHvCvj0zs
You will need a valid Client ID and Secret code before you can use the API. You will need to retrieve this through the Tradedoubler API Client UI. For more information see oAuth Section
The reponse format for all API requests is JSON. All requests should therefore contain the following header:
Content-Type: application/json
To ensure system stability we apply limits to the number of API requests allowed by API Clients. This is limited to 60 requests per minute. If you exceed this you will receive the a HTTP 429 Too Many Requests Status Error with the response body:
API rate limit exceeded
Please wait another minute and you will be able to make API requests again.
To handle large results and to optimise performance of our API we use paginatation on a number of our endpoints to reduce the size of results returned to the client. All endpoints supporting pagination will return 2 attributes:
offset
limit
To page through the results you need to supply two fields within the body of your GET request:
Paramater | Description | Details |
---|---|---|
offset | Offset the results by a specified amount | Integer, default is 0 |
limit | Limit the number of results to be returned | Integer, default is 20, maxmium limit is 100 unless specified |
For example:
If the limit is default at 20 and an endpoint produces 100 results, only the first 20 will be returned (results 0 to 19).
In order to retrieve the remaining results, use the offset parameter. In this example, adding offset=20 to the query string parameters.
Results begin at offset 0. If you're retrieving a report with limit=20, page 2 will begin at offset=20, page 3 at offset=40, page 4 at offset=60, etc.
Advertiser users can be given one of four roles. This determines which endpoints they can access.
Method | URL | Owner | Admin | Member | Read-only |
---|---|---|---|---|---|
GET | /users/me | ✔ | ✔ | ✔ | ✔ |
PUT | /users/me | ✔ | ✔ | ✔ | ✔ |
PUT | /users/me/password | ✔ | ✔ | ✔ | ✔ |
GET | /users/me/password/reset | ✔ | ✔ | ✔ | ✔ |
PUT | /users/me/password/reset | ✔ | ✔ | ✔ | ✔ |
POST | /users/me/password/reset | ✔ | ✔ | ✔ | ✔ |
GET | /users | ✔ | |||
POST | /users | ✔ | |||
GET | /users/{logonAccountId} | ✔ | |||
PUT | /users/{logonAccountId} | ✔ | |||
DELETE | /users/{logonAccountId} | ✔ |
Method | URL | Owner | Admin | Member | Read-only |
---|---|---|---|---|---|
GET | /ads | ✔ | ✔ | ✔ | ✔ |
PUT | /ads | ✔ | ✔ | ✔ | |
POST | /ads | ✔ | ✔ | ✔ | |
DELETE | /ads | ✔ | ✔ | ✔ | |
GET | /programs | ✔ | ✔ | ✔ | ✔ |
POST | /programs | ✔ | ✔ | ||
GET | /programs/{programId} | ✔ | ✔ | ✔ | ✔ |
PUT | /programs/{programId} | ✔ | ✔ | ✔ | |
GET | /programs/{programId}/advanced | ✔ | ✔ | ||
PUT | /programs/{programId}/advanced | ✔ | ✔ | ||
GET | /programs/{programId}/commissions | ✔ | ✔ | ✔ | ✔ |
POST | /programs/{programId}/commissions | ✔ | ✔ | ||
GET | /programs/{programId}/segments | ✔ | ✔ | ✔ | ✔ |
PUT | /programs/{programId}/segments | ✔ | ✔ | ||
POST | /programs/{programId}/segments | ✔ | ✔ | ||
GET | /programs/{programId}/sources | ✔ | ✔ | ✔ | ✔ |
PUT | /programs/{programId}/sources✔ | ✔ | |||
GET | /events | ✔ | ✔ | ✔ | ✔ |
PUT | /events | ✔ | ✔ | ||
POST | /events | ✔ | ✔ | ||
GET | /tokens | ✔ | ✔ | ✔ | |
POST | /tokens | ✔ | ✔ | ||
GET | /salesPending | ✔ | ✔ | ✔ | |
PUT | /salesPending | ✔ | ✔ | ✔ | |
GET | /invoices | ✔ | ✔ | ||
GET | /invoices/{invoiceId} | ✔ | ✔ | ||
GET | /sources | ✔ | ✔ | ✔ | ✔ |
GET | /sources/{sourceId} | ✔ | ✔ | ✔ | ✔ |
POST | /sources/apply | ✔ | ✔ | ✔ | ✔ |
Method | URL | Owner | Admin | Member | Read-only |
---|---|---|---|---|---|
GET | /statistics | ✔ | ✔ | ✔ | ✔ |
GET | /statistics/export | ✔ | ✔ | ✔ | ✔ |
GET | /transactions | ✔ | ✔ | ✔ | ✔ |
GET | /transactions/export | ✔ | ✔ | ✔ | ✔ |
GET | /dashboard | ✔ | ✔ | ✔ | ✔ |
GET | /dashboard/programs | ✔ | ✔ | ✔ | ✔ |
GET | /dashboard/sources | ✔ | ✔ | ✔ | ✔ |
Tradedoubler APIs use oAuth2 authentification with refreshTokens. All requests must be validated with a bearerToken in the header request.
Only use oAuth2 credentials when you don't already have a refresh token!
To use our APIs you will need to create a client which provides a ClientId and ClientSecret. The client is required to generate a bearer token which is used on all subsequent API requests to validate your account and role. You can create your API client using our tool at the following URL: https://solutions.tradedoubler.com/tools/api-client
Your clientSecret is only shown once when you create a new client. If you do not know your clientSecret you must delete and recreate the client in the API Client UI!
To generate a bearer token you need to send a POST request to the oauth endpoint with your username and password. All requests have to be signed with an Authorization generated by a valid ClientID and ClientSecret in the Header:
Authorization: Basic U3dhZ3dsciByb2Nrcw==
Where U3dhZ3dsciByb2Nrcw==
is Base64 encoding of ClientID and ClientSecret
base64encoded(ClientID:ClientSecret)
To refresh a token you need to send a POST request to the oauth endpoint with the refresh token received in the response when generating a bearer token. All requests have to be signed with an Authorization generated by a valid ClientID and ClientSecret in the Header:
Authorization: Basic U3dhZ3dsciByb2Nrcw==
Where U3dhZ3dsciByb2Nrcw==
is Base64 encoding of ClientID and ClientSecret
base64encoded(ClientID:ClientSecret)
Users have access to Advertiser Organization and have four roles available: Owner, Admin, Write, Read. An Advertiser Organization always has one user with the role owner. This service allows the creation and management of users for the Advertiser Organization.
A User is an individual logon account connected to a Publisher organization.
Get details related to current logged in user. This is available for any role.
1234567
user123
A
User
user's email address
user@tradedoubler.com
Role ID of user, 1 = Owner, 2 = Admin, 3 = Member, 4 = Read-only
1
2 Character language code of user (ISO 639-1)
en
1234567
When Publisher is in a private network, the ID of the private network organization
0
array of countries the user should have access to. Countries should be ISO_3166-1 Alpha-2
Y
User type, if a publisher or advertiser. Advertiser typeId is always 2
2
123456
3 character currency code (ISO 4217)
EUR
Update details related to current logged in user. This is available for any role.
user123
A
User
user's email address
user@tradedoubler.com
2 Character language code of user (ISO 639-1)
en
newsletter preferences, Y to receive, N to opt-out
Y
3 character currency code (ISO 4217)
EUR
Provides a list of all users connected to the Publisher Organization. This is only available for the user with the role Owner.
Create a new user for a Publisher Organization.
user123
A
User
user's email address
user@tradedoubler.com
Role ID of user, 1 = Owner, 2 = Admin, 3 = Member, 4 = Read-only
1
user's password
aUn1queP@ssword
2 Character language code of user (ISO 639-1)
en
array of countries the user should have access to. Countries should be ISO_3166-1 Alpha-2.
Y
3 character currency code (ISO 4217)
EUR
Provides information for a specific user based on their logonAcccountId. This is only available for the user with the role Owner.
1234567
user123
A
User
user's email address
user@tradedoubler.com
Role ID of user, 1 = Owner, 2 = Admin, 3 = Member, 4 = Read-only
1
2 Character language code of user (ISO 639-1)
en
1234567
When Publisher is in a private network, the ID of the private network organization
0
array of countries the user should have access to. Countries should be ISO_3166-1 Alpha-2
Y
User type, if a publisher or advertiser. Advertiser typeId is always 2
2
123456
3 character currency code (ISO 4217)
EUR
Update information for a specific user based on their logonAcccountId. This is only available for the user with the role Owner.
user123
A
User
user's email address
user@tradedoubler.com
Role ID of user, 1 = Owner, 2 = Admin, 3 = Member, 4 = Read-only
1
2 Character language code of user (ISO 639-1)
en
array of countries the user should have access to. Countries should be ISO_3166-1 Alpha-2
Y
3 character currency code (ISO 4217)
EUR
Delete a user a specific user based on their logonAcccountId, this will remove their access to login or access any Publisher Organization information. This is only available for the user with the role Owner.
Change the password of logged in user
You can view a list of available ads on a specific program
programId | Filter available ads for specific programs |
---|---|
adType | Filter available ads based on the type |
adSize | Filter available ads based on the Size. This is a free text search, to search for width use "300x" and for height only "x250" |
adName | Filter available ads based on the Name |
adId | Filter for a specific ad |
includeExpired | Where to include expired ads (default value: false) |
sortBy | |
sortOrder | |
offset | |
limit |
123456
A Program
12345678
DefaultAd
300x250
01-17T23:00:00.000+0200 (date) - Date and time the ad was last updated
2020
01-01T12:00:00.000+0200 (date) - Date and time the ad was created
2020
Type of ad. 1 = text, 4 = image, 6 = html
4
100x100.jpg - url where the ad is hosted if an image
http://test.tradedoubler.com/file/30539/18.01.17_logo/selection
url the ad redirects to, applies to image and text ads
http://www.tradedoubler.com
<html>...</html>
This is an ad
You can create a text, image or HTML ad programmatically through the API
You can view more details on a specific ad. This is also useful if you want to update an existing ad.
adId |
---|
You can view a list of available programs for your organization
active | Filter by the active status of program |
---|---|
paused | Filter by the paused status of the program |
countryCode | Filter programs on a specific country - ISO (add countrycode) |
name | Filter on the name of the program. |
categoryIds | Filter based on program categories |
sortBy | |
sortOrder | |
offset | |
limit |
123456
GB
if the program is a closed program, then it is invite only, publishers can not apply via the interface
true
true
false
08-21 - the date the program was created
2009
08-21 - the date the programw went live
2009
ATestProgram
the url for the program's logo
https://www.logo.com
if the program is prepayment then the advertiser is invoiced in advance, this allows publishers to be paid much quicker. Otherwise advertisers are invoiced on a monthly basis.
false
true
The keyword policy rule for the program. 0=no keyword policy, 1 = Open policy, 2 = Restricted, 3 = Closed.
0
The type of tracking setup for the program. 1 = Click tracking program only, 2 = on-site conversion tracking, 3rd party setup, 3 = on-site conversion tracking, 1st party setup, 4 offline tracking, 3rd party setup, 5 = offline conversion tracking, 1st party setup, 6-Unknown.
3
GBP
You can view a specific program from your organization
programId |
---|
123456
ATestProgram
true
if the program is a closed program, then it is invite only, publishers can not apply via the interface
true
GBP
GB
https://www.tradedoubler.com
the url for the program's logo
http://www.tradedoubler.com/logo.jpg
0.5
30
false
if impression tracking is enabled, if no click has been found
true
true
true
the type of tracking setup for the program. 1 = Click tracking program only, 2 = on-site conversion tracking, 3rd party setup, 3 = on-site conversion tracking, 1st party setup, 4 offline tracking, 3rd party setup, 5 = offline conversion tracking, 1st party setup, 6-Unknown.
3
08-21 - the date the programw went live
2009
if the program has ended, the date it ended.
null
false
true
You can view advanced information on a specific program from your organization
programId |
---|
123456
ATestProgram
if the sales from exclusive vouchers should be re-allocated to the affiliate granted the exclusive code
true
URL to redirect users to when clicking on a program link. Usually used for third party trackers like DoubleClick or Advertiser's own redirect scripts
"https://redir.tradedoubler.com/redirects"
false
12
4
ID for the time zone, see time zone endpoint for all available time zones
15
UTC +1
https://*.tradedoubler.com
If the program uses Product Level Tracking. 1 = NO ; 2 = HYBRID, both PLT and normal events can be used; 3 = YES, PLT only.
1
if the deeplink/landing page should be url encoded before being added to a redirect URL
true
if the Tradedoubler's cookie ID, tduid, should be added to the deeplink/landing page to enable first party tracking.
{ "id": 123456, "name": "ATestProgram", "exclusiveVoucher": true, "redirectUrl": "https://redir.tradedoubler.com/redirects", "directLink": false, "uniqueImpressions": 12, "ImpressionWindow": 4, "timeZoneId": 15, "timeZone": "UTC +1", "allowedDomains": "https://.tradedoubler.com,https://www.tradedoubler.", "plt": 1, "autoApprove": { "action": "A", "days": 30 }, "encodeUrl": true, "firstPartyTracking": true }
true
You can view texts that relate to your programs such as program description, short description etc...
programId |
---|
You can view all available timeZones and the corresponding IDs
Standardised way to end a program. If a program has received no traffic then program is ended immediately. If program has traffic, it is set to end in 30 days to give publishers time to redirect their traffic.
programId | |
---|---|
td_mainclosurer | |
td_secondaryClo |
Manage sources connected to your programs. You can view applications, accepted sources as well as their category and ranking.
You can view more details on a specific ad. This is also useful if you want to update an existing ad.
programId | |
---|---|
segmentId | Filter sources within a specific segment, comma seperated for multiple segments |
statusId | The connection status of the program and source i.e. 1 is under consideration. Comma seperated for multiple statuses |
sourceId | Filter by source |
rank | Filter by rank |
sortBy | |
sortOrder | |
offset | |
limit |
Commissions are the fees paid to your publishers for generating traffic and/or sales to your programs. A commission is created for an event (a click, lead or sale) and created for programs. To setup different commission levels you assign commissions against a segment (which is used to group sources)
A list of commissions for a specific program. You can filter by status - active commissions, past or future - or view commissions for specific segments.
programId | |
---|---|
segmentIds | Filter commissions for specific segments. Mutiple ids should be comma seperated |
status | filter on the status of the commission, multiple values should be comma seperated |
sortBy | |
sortOrder | |
offset | |
limit |
All changes to commissions are a post request as we create a new commission in our system.
Segments are used to group sources for each program. By using segments you can easily setup different commission levels on your programs and manage your sources more easily.
A list of segments created for a specific program.
programId | |
---|---|
deleted | Include segments that have been deleted. (@Nick Check if it true it is deleted and not) |
sortBy | |
sortOrder | |
offset | |
limit |
In Tradedoubler transactions can be given a pending status whereby an advertiser has a set amount of time to validate a pending sale (usually up to 90 days) and approve/deny the transaction. This is usually to allow for an advertiser's returns or cancellation policy. Being able to approve a transaction in Tradedoubler as soon as it is confirmed in an advertiser's system provides greater transparency to your publishers around when they will be paid for their activities.
Get a list of all your transactions (leads and sales) and see the time until they will automatically validate
programIds | Filter pending transactions for specific programs. Mutiple ids should be comma seperated |
---|---|
startDate | filter if the commission is active after the start date. (ISO-8601 YYYYMMDD) |
endDate | filter if the commission is active or does not stop before the end date. (ISO-8601 YYYYMMDD) |
sortBy | |
sortOrder | |
offset | |
limit |
Validate transactions by changing the status to approved or denied. For transactions that are denied we require a reasonId to give the publisher greater transparency as to why the transaction was denied. (@Nick add reason codes). It is possible to modify the order value for a transactions to reflect a partial return/cancellation, this can also be done without updating the transaction status - i.e. the transaction will remain in a pending state.
123456
Action to apply to the transaction i.e. approve, deny or update
Approve
When denying a transaction, you must supply a reason
When updating a transaction, the new order value i.e. for partial returns
0.99
When updating a transaction, the currency for the new order value
EUR
Advertisers can create their own categories which can be applied to any of their sources. They can used as filters when managing sources or for reporting.
Get categories created for an advertiser to use for sources
categoryName | Free text search on category name |
---|---|
categoryId | Filter by the category id |
sortBy | |
sortOrder | |
offset | |
limit |
Create a new custom category
View invoices and their status and get copies of your invoice.
List of invoices
invoiceNumber | Invoice number |
---|---|
invoiceStatus | Status of the invoice @Nick to add options |
programId | Filter invoices that relate to a program |
fromDate | Include invoices from a date |
toDate | Include invoices up to a date |
Custom events are a flexible way of tracking which products, categories or services converted. This provides better reporting insight and the ability to set different commissions for different events in order to maintain margin control. Each event can have a different pending period to reflect the different returns/cancellation policies based on the type of product or service.
Get custom events created for an advertiser
eventTypeId | Filters on eventType - leads or Sales |
---|---|
pending | Filters on if the event has a pending period |
ruleId | Filters on the events rule. |
sortBy | |
sortOrder | |
offset | |
limit |
Create a new event for your programs.
Update an existing event. You cannot change the type of event (from a sale to a lead or vice versa), you would need to create a new event.
Tokens are required to use Tradedoubler's older API services: Products, Vouchers, Claims and Conversions. Documentation found at: https://dev.tradedoubler.com
You can view a list of available tokens:
You can refresh your token should you require:
Statistics is the main reporting endpoint. This reflects a lot of work to simplify Tradedoubler's reports from the old advertiser interface into a single endpoint with the ability to change how the statistics are grouped.
Detailed statistics for advertiser, they can be grouped by date, source, program, ad.
intervalType | Interval Grouping. |
---|---|
reportType | Report Type Grouping |
fromDate | The date the report runs from |
toDate | The date the report runs until |
sourceId | Filter by a source ID |
programId | Filter by a program ID |
adId | Filter by an ad ID |
reportCurrencyC | The ISO 4217 code of currency |
sortBy | The field used to sort the results |
sortOrder | The order the sort field is sorted by (asc or desc) |
offset | Offset to get results from |
limit | Number of records to be retrieved |
Export summary statistics into another reporting format - for analysis in tools such as Excel
format | Format of the export file |
---|---|
intervalType | Interval Grouping. |
reportType | Report Type Grouping |
fromDate | The date the report runs from |
toDate | The date the report runs until |
sourceId | Filter by a source ID |
programId | Filter by a program ID |
adId | Filter by an ad ID |
reportCurrencyC | The ISO 4217 code of currency |
sortBy | The field used to sort the results |
sortOrder | The order the sort field is sorted by (asc or desc) |
offset | Offset to get results from |
limit | Number of records to be retrieved |
Transactions relate to sales or leads and give detailed information
List of transactions for a given source
fromDate | The date the report runs from, optionally you can provide the time, if no time provided we assume 00:00:00 |
---|---|
toDate | The date the report runs until, optionally you can provide the time, if no time provided we assume 23:59:59 |
lastModified | Apply date range to timeofLastModif |
reportCurrencyC | The ISO 4217 code of currency |
programId | Filter by a program ID |
sourceId | Filter by Source ID. |
adId | Filter by an ad ID |
eventId | Filter by an event ID |
orderOrLeadNumb | Filter transactions by order or lead number |
status | The status of a transaction
|
sortBy | The field used to sort the results |
sortOrder | The order the sort field is sorted by (asc or desc) |
offset | Offset to get results from |
limit | Number of records to be retrieved |
123456789
123456
Program 1
Source 1
1234567
12345678
123456
The event name describes the transction that took place (this could be a subscription, product, or general sale)
A Sale Event
This donates the type
of transaction, where 4 = Lead (a transaction with no monetary value like a registration) and 5 = Sale
5
For transactions with a pending period this is the current status, where A = Accepted, P = Pending and D = Denied
A
2019-02-18 19:07:59.0
The timestamp of when the transaction was created in Tradedoubler's database (for offline sales this can be some time after the time of transaction)
2019-02-27 00:38:28.0
2019-02-26 23:17:56.0
The timestamp of when the transaction was last changed (usually when the status after an advertiser validates transactions)
null
When eventTypeId = 4 (transaction is a lead) the leadNumber for the transaction
null
When eventTypeId = 5 (transaction is a sale) the orderNumber for the transaction
order123
When eventTypeId = 5 (transaction is a sale) the order value for the transaction
100
10
false
10PERCENT
1 (string) - If the sale was cross device, the validation method id
auto_approve
Device Object contains all device information related to the transaction if it took place on a mobile/tablet
false
Export list of transactions for a given source
format | Format of the export file |
---|---|
sourceId | Source ID. Currently we only allow transactions report to be run for one Source at a time. |
fromDate | The date the report runs from, optionally you can provide the time, if no time provided we assume 00:00:00 |
toDate | The date the report runs until, optionally you can provide the time, if no time provided we assume 23:59:59 |
lastModified | Apply date range to timeofLastModif |
programId | Filter by a program ID |
adId | Filter by an ad ID |
reportCurrencyC | The ISO 4217 code of currency |
orderOrLeadNumb | Filter transactions by order or lead number |
sortBy | The field used to sort the results |
sortOrder | The order the sort field is sorted by (asc or desc) |
offset | Offset to get results from |
limit | Number of records to be retrieved |
123456
Program 1
Source 1
1234567
123456
The event name describes the transction that took place (this could be a subscription, product, or general sale)
A Sale Event
This donates the type
of transaction, where 4 = Lead (a transaction with no monetary value like a registration) and 5 = Sale
5
For transactions with a pending period this is the current status, where A = Accepted, P = Pending and D = Denied
A
2019-02-18 19:07:59.0
The timestamp of when the transaction was created in Tradedoubler's database (for offline sales this can be some time after the time of transaction)
2019-02-27 00:38:28.0
2019-02-26 23:17:56.0
The timestamp of when the transaction was last changed (usually when the status after an advertiser validates transactions)
null
When eventTypeId = 4 (transaction is a lead) the leadNumber for the transaction
null
When eventTypeId = 5 (transaction is a sale) the orderNumber for the transaction
order123
When eventTypeId = 5 (transaction is a sale) the order value for the transaction
100
10
false
10PERCENT
1 (string) - If the sale was cross device, the validation method id
auto_approve
Device Object contains all device information related to the transaction if it took place on a mobile/tablet
false
Collection of summary reports
Summary statistics used for the dashboard within the publisher interface.
intervalType | Date range for the report |
---|---|
reportCurrencyC | The ISO 4217 code of the currency. |
Provides summary statistics sorted for top performing programs
intervalType | Date range for the report |
---|---|
reportCurrencyC | The ISO 4217 code of the currency. |
sortBy | The field used to sort the results |
sortOrder | The order the sort field is sorted by (asc or desc) |
offset | Offset to get results from |
limit | Number of records to be retrieved |
Provides summary statistics sorted for top performing sources
intervalType | Date range for the report |
---|---|
reportCurrencyC | The ISO 4217 code of the currency. |
sortBy | The field used to sort the results |
sortOrder | The order the sort field is sorted by (asc or desc) |
offset | Offset to get results from |
limit | Number of records to be retrieved |