Tradedoubler Publisher Management API

Introduction

This is the API documentation for Tradedoubler's Publisher platform. At Tradedoubler we expose all features available in our web UI through the API. If you spot any incorrect information please: Email Us

Authentication

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 Publisher UI. For more information see oAuth Section

Response Formats

The reponse format for all API requests is JSON. All requests should therefore contain the following header:

Content-Type: application/json

Rate Limiting

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.

Paging

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.

Roles

Publisher users can be given one of four roles. This determines which endpoints they can access.

User Management

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}	✔
GET	/users/countries	✔
POST	/users/countries	✔

Account Management

Method	URL	Owner	Admin	Member	Read-only
GET	/account	✔	✔	✔	✔
PUT	/account	✔
DELETE	/account	✔
GET	/account/options	✔	✔
GET	/ads	✔	✔	✔	✔
GET	/sources	✔	✔	✔	✔
POST	/sources	✔	✔	✔
GET	/sources/{sourceId}	✔	✔	✔	✔
PUT	/sources/{sourceId}	✔	✔	✔
DELETE	/sources/{sourceId}	✔	✔	✔
GET	/sources/options/countries	✔	✔	✔	✔
GET	/sources/options/languages	✔	✔	✔	✔
GET	/sources/options/promotiontypes	✔	✔	✔	✔
GET	/sources/options/sourcetypes	✔	✔	✔	✔
GET	/programs	✔	✔	✔	✔
GET	/programs/detail	✔	✔	✔	✔
POST	/programs/apply	✔	✔	✔
GET	/tokens	✔	✔	✔
POST	/tokens	✔	✔
GET	/payment/settings	✔	✔
PUT	/payment/settings	✔
GET	/payment/providers	✔
GET	/payment/settings/fields/tradedoubler	✔
GET	/payment/settings/fields/payoneer	✔

Reporting

Method	URL	Owner	Admin	Member	Read-only
GET	/statistics	✔	✔	✔	✔
GET	/statistics/export	✔	✔	✔	✔
GET	/transactions	✔	✔	✔	✔
GET	/transactions/export	✔	✔	✔	✔
GET	/transactions/payments	✔	✔	✔	✔
GET	/transactions/export/payments	✔	✔	✔	✔
GET	/dashboard	✔	✔	✔	✔
GET	/dashboard/programs	✔	✔	✔	✔
GET	/dashboard/sources	✔	✔	✔	✔
GET	/payments	✔	✔
GET	/payments/{paymentId}	✔	✔
GET	/payments/earnings	✔	✔	✔	✔
GET	/payments/accountBalanceBreakdown	✔	✔	✔	✔
GET	/payments/pendingEarningsBreakdown	✔	✔	✔	✔
GET	/payments/digitalWallets	✔	✔	✔	✔

Reference

oAuth 2.0

Bearer and Refresh Token

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!

Client Credentials

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. This is created in the Publisher UI: https://publishers.tradedoubler.com/en/uaa/clients

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 Publisher UI!

ClientPage

Bearer token

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 (seperated by a colon and no whitespaces) base64encoded(ClientID:ClientSecret)

200 OK

Refresh Token

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 (seperated by a colon and no whitespaces) base64encoded(ClientID:ClientSecret)

200 OK

Users

Users have access to Publisher Organization and have four roles available: Owner, Admin, Write, Read. A Publisher Organization always has one user with the role owner. This service allows the creation and management of users for the Publisher Organization.

My User

A User is an individual logon account connected to a Publisher organization.

Get My User Details

Get details related to current logged in user. This is available for any role.

Response

object

logonAccountId
Logon ID of the user
number
1234567
username
username for login
string
user123
firstName
string
A
lastName
string
User
email
user's email address
string
user@tradedoubler.com
roleId
Role ID of user, 1 = Owner, 2 = Admin, 3 = Member, 4 = Read-only
number
1
languageId
2 Character language code of user (ISO 639-1)
string
en
organizationId
Organization ID of the Publisher the user belongs to
number
1234567
owningOrganizationId
When Publisher is in a private network, the ID of the private network organization
number
0
countryAccess
array of countries the user should have access to. Countries should be ISO_3166-1 Alpha-2
array[string]
newsletter
Y or N if the user should receive newsletters from Tradedoubler
string
Y
typeId
User type, if a publisher or advertiser. Publisher typeId is always 1
number
1
personId
Person ID of the user
number
123456

Update My User Information

Update details related to current logged in user. This is available for any role.

Request

object

username
username for login
string
user123
firstName
string
A
lastName
string
User
email
user's email address
string
user@tradedoubler.com
languageId
2 Character language code of user (ISO 639-1)
string
en

Users

List Users

Provides a list of all users connected to the Publisher Organization. This is only available for the user with the role Owner.

Create a user

Create a new user for a Publisher Organization.

200 OK

Request

object

username
username for login
string
user123
firstName
string
A
lastName
string
User
email
user's email address
string
user@tradedoubler.com
roleId
Role ID of user, 1 = Owner, 2 = Admin, 3 = Member, 4 = Read-only
number
1
password
user's password
string
aUn1queP@ssword
languageId
2 Character language code of user (ISO 639-1)
string
en
countryAccess
array of countries the user should have access to. Countries should be ISO_3166-1 Alpha-2
array[string]
newsletter
Y or N if the user should receive newsletters from Tradedoubler
string
Y

User By Id

Get a specific User

Provides information for a specific user based on their logonAcccountId. This is only available for the user with the role Owner.

Request

object

logonAccountId
Logon ID of the user
number
1234567
username
username for login
string
user123
firstName
string
A
lastName
string
User
email
user's email address
string
user@tradedoubler.com
roleId
Role ID of user, 1 = Owner, 2 = Admin, 3 = Member, 4 = Read-only
number
1
languageId
2 Character language code of user (ISO 639-1)
string
en
organizationId
Organization ID of the Publisher the user belongs to
number
1234567
owningOrganizationId
When Publisher is in a private network, the ID of the private network organization
number
0
countryAccess
array of countries the user should have access to. Countries should be ISO_3166-1 Alpha-2
array[string]
newsletter
Y or N if the user should receive newsletters from Tradedoubler
string
Y
typeId
User type, if a publisher or advertiser. Publisher typeId is always 1
number
1
personId
Person ID of the user
number
123456

Update a user

Update information for a specific user based on their logonAcccountId. This is only available for the user with the role Owner.

Request

object

username
username for login
string
user123
firstName
string
A
lastName
string
User
email
user's email address
string
user@tradedoubler.com
roleId
Role ID of user, 1 = Owner, 2 = Admin, 3 = Member, 4 = Read-only
number
1
languageId
2 Character language code of user (ISO 639-1)
string
en
countryAccess
array of countries the user should have access to. Countries should be ISO_3166-1 Alpha-2
array[string]
newsletter
Y or N if the user should receive newsletters from Tradedoubler
string
Y

Delete a user

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.

Password

Change Password

Change the password of logged in user

Account

Provides the Account information for the Publisher Organization a user is connected to.

Account Information

Get Account Information

View account information for the Publisher Organization. This is only available for users with the role Owner or Admin.

Response

object

organization
object
id
Publisher Organization ID
number
1234567
name
Publisher Organization Name
string
Tradedoubler
phone
Phone number, must include country code
string
"+46 84050800"
phone2
Optional additional phone number, must include country code
string
"+46 84050800"
logoUrl
URL of your logo
string
https://www.tradedoubler.com/logo.jpg
description
Add a description about your business
string
About us
address
object
street
1st line of address
string
Floor 7
street2
Optional field for 2nd line of address
string
57A Birger Jarlsgatan
zipCode
Zip or postal code
string
113 56
city
City
string
Stockholm
countryCode
ISO-3166 Alpha 2 country code
string
SE
county
Optional county name
string
Stockholm
preferences
object
currencyCode
ISO-4217 currency code
string
SEK
referencePerson
object
personId
number
123456
firstName
string
Test
lastName
string
Test

Update Account Information

Update the Publisher Organization account information. Only users with the role Owner can change this.

Request

object

organization
object
id
Publisher Organization ID
number
1234567
name
Publisher Organization Name
string
Tradedoubler
phone
Phone number, must include country code
string
"+46 84050800"
phone2
Optional additional phone number, must include country code
string
"+46 84050800"
logoUrl
URL of your logo
string
https://www.tradedoubler.com/logo.jpg
description
Add a description about your business
string
About us
address
object
street
1st line of address
string
Floor 7
street2
Optional field for 2nd line of address
string
57A Birger Jarlsgatan
zipCode
Zip or postal code
string
113 56
city
City
string
Stockholm
countryCode
ISO-3166 Alpha 2 country code
string
SE
county
Optional county name
string
Stockholm
preferences
object
currencyCode
ISO-4217 currency code
string
SEK

Delete Account

Delete the Publisher Organization and all connected users. Only an Owner can use this service.

Account Options

Provides all available options for the Publisher Organization Account. This is useful for any updates.

Active Countries

Get Available Countries

Returns a list of all available countries in Tradedoubler's network (or a private network) that a publisher can operate in

Add Additional Countries

Allows the publisher to work in additional countries

200 OK

List All Ads

You can view a list of available ads either across all programs you are connected to or filtered by a number of options:

URI Parameters
sourceId	Filter available ads based on the ID of a specific source/website
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
categoryIds	Filter available ads based on program categories
statusId	Filter available ads based on programs your connection status
sortBy
sortOrder
offset
limit

Programs

Program

List Programs

You can view a list of available programs:

URI Parameters
sourceId	Filter available programs based on the ID of a specific source/website
statusId	Filter available programs based on your connection status
name	Filter available programs based on the Name
categoryIds	Filter available ads based on program categories
sortBy
sortOrder
offset
limit

Program Detail

You can view detailed information on a specific programs:

URI Parameters
sourceId	Filter available programs based on the ID of a specific source/website
programId	Filter available programs based on your connection status

Response

object

id
unique Id for the program
string
123456
defaultTracking
default tracking link
string
https://clk.tradedoubler.com/click?p=123456&a=654321
name
Name of the program
string
Program Name
countryCode
country code of the program
string
GB
closedProgram
if the program is a closed program, then it is invite only, publishers can not apply via the interface
string
true
paused
if the program is in a paused state then no statistics will show until it is unpaused. Contact your Tradedoubler Account Manager to request a program is no longer paused.
string
false
categoryIds
The Ids of categories the program has been mapped to. See parameters for more information
array[number]
logoUrl
the url for the program's logo
string
https://www.tradedoubler.com/logo.gif
prepayment
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.
string
false
createdDate
the date the program was created
string
2009-08-21
startDate
the date the program went live
string
2009-08-21
statusId
the program connection status for your source
object
productFeed
if the program has a connected product feed
string
true
avgEpc
average earnings per click
string
0
keywordPolicyId
The Keyword Policy for Publishers using paid search
object
implementationTypeId
The type of tracking setup for the program
object
autoAccept
false - if the program auto accepts applications
string
daysToAutoAccept
the maximum time an application will be under consideration before being auto accepted
string
texts
advertiser information for the program. textTypeId indicates the type of program text
object
responsibleDetails
contact details of the relevant Tradedoubler Account Manager
string
showPerformance
if false, performance criteria such as avgEpc are not shown
string
acceptClaims
if the program allows publishers to submit untracked sales claims
string
currencyCode
the currency the program is set to track in
string
GBP
deepLinking
if the program allows publishers to deeplink to product pages
string
true
segmentTariffs
an object containing a list of all commissions applicable for the program
object
pltSegmentTariff
if the program supports Product Level Tracking, a list of all product groups and commissions
object
pltSegmentPromotions
if the program supports Product Level Tracking, a list of all product level promotions and commissions
array

Apply to program

You can view detailed information on a specific programs:

200 OK

Request

object

sourceId
number
1234567
programId
number
123456

Sources

A source is website or app that generates traffic

Source

List sources

You can view a list of available programs:

Create a source

You can view detailed information on a specific programs:

200 OK

Request

object

name
Name of your source
string
Tradedoubler
url
URL for your website or link to your app in app store
string
https://www.tradedoubler.com
countryCode
ISO-3166 Alpha 2 country code
string
SE
promotionTypeId
See Promotion Type
number
1
description
A description used to identify the traffic source
string
Tradedoubler default source
sourceTypeId
See Source type
number
1

Source by ID

Get a source

You can view detailed information on a specific programs:

URI Parameters
sourceId	Filter available programs based on the ID of a specific source/website

Update a source

You can view detailed information on a specific programs:

URI Parameters
sourceId	Filter available programs based on the ID of a specific source/website

Delete a source

You can view detailed information on a specific programs:

URI Parameters
sourceId	The ID of the source/website to delete

Source Options

Get available countries for sources

You can view detailed information on a specific programs:

Get available languages for sources

You can view detailed information on a specific programs:

Get available promotion types for sources

You can view detailed information on a specific programs:

Get available types for sources

You can view detailed information on a specific programs:

Tokens

Publisher Tokens

Tokens are required to use Tradedoubler's older API services: Products, Vouchers, Claims and Conversions. Documentation found at: https://dev.tradedoubler.com Publisher tokens work for all sources. Site tokens work only for the specified source ID.

List tokens

You can view a list of available tokens:

Refresh a token

You can refresh your token should you require:

200 OK

Payment Settings

Publishers are required to choose how they will be paid and enter their payment details. Currently Tradedoubler has two payment providers: Tradedoubler are able to support SEPA (Single Euro Payment Area) which covers most European counties. For any partners outside of SEPA please sign up to our partner Payoneer

Payment Settings

Current Payment Settings

Gets the current payment provider for the Publisher Organization and all related payment settings

Change Payment Settings

To change the payment settings

when changing payment provider to Tradedoubler see #reference/payment-settings/Tradedoubler-fields to see which fields are required. This will also change based on the company type and country based (for example in Sweden where personal number is required for certain business types)
when changing payment provider to Payoneer see #reference/payment-settings/Payoneer-fields for required fields

Available Providers

Available payment providers

List of available payment providers - currently Tradedoubler for SEPA and Payoneer for rest of the world

Tradedoubler Fields

List of fields that are required when updating payment provider to Tradedoubler. Fields required differ based on if the publisher organization is an company or individual or charitble organization.

URI Parameters
businessTypeId	Unique ID for the business type (1 - individual, 2 - Non-taxable organization, 3 - VAT registered company)
bankCountryCode	Bank country code (ISO Alpha 2)
accountType	mandatory only for Sweden ("bankCountryCode": "SE") where the value is either BANKACCOUNT, BANKGIRO or IBAN

Payoneer Fields

URI Parameters
businessTypeId	Unique ID for the business type (1 - individual, 2 - Non-taxable organization, 3 - VAT registered company)
bankCountryCode	Bank country code (ISO Alpha 2)

Reporting

Statistics

Statistics is the main reporting endpoint. This reflects a lot of work to simplify Tradedoubler's reports from the old publisher interface into a single endpoint with the ability to change how the statistics are grouped.

Statistics

Detailed statistics for publisher, they can be grouped by date, source, program, ad or EPI (Enhanced Publisher Information). To see clicks at EPI level speak to your publisher manager.

URI Parameters
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
reportCurrencyCode	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

Export summary statistics into another reporting format - for analysis in tools such as Excel

URI Parameters
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
reportCurrencyCode	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)

Transaction

Transactions relate to sales or leads and give detailed information

List transaction

List of transactions for a given source

URI Parameters
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
toDate	The date the report runs until
lastModified	Apply date range to timeofLastModification
programId	Filter by a program ID
adId	Filter by an ad ID
reportCurrencyCode	The ISO 4217 code of currency
epi1	Filter for transactions containing free text in EPI field (Enhanced Publisher Information)
epi2	Filter for transactions containing free text in EPI2 field (Enhanced Publisher Information)
orderOrLeadNumber	Filter transactions by order or lead number
paymentId	Filter by paymentId
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

Response

object

transactionId
Unique ID for each transaction
number
99999888901
programId
The ID for the program where the transaction took place
number
123456
programName
The name of the program where the transaction took place
string
Program 1
sourceName
The name of the source that was attributed the transaction
string
Source 1
sourceId
The ID of the source that was attributed the transaction
number
1234567
eventId
The event ID for the transaction
number
123456
eventName
The event name describes the transction that took place (this could be a subscription, product, or general sale)
string
A Sale Event
eventTypeId
This donates the type of transaction, where 4 = Lead (a transaction with no monetary value like a registration) and 5 = Sale
number
5
status
For transactions with a pending period this is the current status, where A = Accepted, P = Pending and D = Denied
string
A
timeofLastClick
The timestamp of the last click before the transaction was made
string
2019-02-18 19:07:59.0
timeofCreate
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)
string
2019-02-27 00:38:28.0
timeofTransaction
The timestamp of when the transaction took place
string
2019-02-26 23:17:56.0
timeofLastModified
The timestamp of when the transaction was last changed (usually when the status after an advertiser validates transactions)
string
null
epi
Enhanced Publisher Information (EPI) is a custom field for publishers to pass their own values (up to 64 bytes), this can be used for sub networks to pass their own internal IDs
string
1234A
epi2
Enhanced Publisher Information 2 (EPI2) is a second custom field for publishers to pass their own values (up to 64 bytes), this can be used for sub networks to pass their own internal IDs
string
ABC4321
leadNumber
When eventTypeId = 4 (transaction is a lead) the leadNumber for the transaction
string
null
orderNumber
When eventTypeId = 5 (transaction is a sale) the orderNumber for the transaction
string
order123
orderValue
When eventTypeId = 5 (transaction is a sale) the order value for the transaction
number
100
commission
The commission attributed to the source for the transaction
number
10
paid
Whether the commission for the transaction has been assigned to a payment invoice and should have been paid to the publisher
string
false
productInfo
ProductInfo Object contains all products in the basket for the transaction if the adveriser supplies this data
object
voucherCode
The voucher code redeemed if it was used for the transaction
string
10PERCENT
productsApi
object
paymentId 1234567
If the transaction has been paid, the paymentId the transaction belongs to
number

Export Transactions

Export list of transactions for a given source

URI Parameters
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
toDate	The date the report runs until
lastModified	Apply date range to timeofLastModification
programId	Filter by a program ID
adId	Filter by an ad ID
reportCurrencyCode	The ISO 4217 code of currency
epi1	Filter for transactions containing free text in EPI field (Enhanced Publisher Information)
epi2	Filter for transactions containing free text in EPI2 field (Enhanced Publisher Information)
orderOrLeadNumber	Filter transactions by order or lead number
paymentId	Filter by paymentId
sortBy	The field used to sort the results
sortOrder	The order the sort field is sorted by (asc or desc)

Response

object

transactionId
Unique ID for each transaction
number
99999888901
programId
The ID for the program where the transaction took place
number
123456
programName
The name of the program where the transaction took place
string
Program 1
sourceName
The name of the source that was attributed the transaction
string
Source 1
sourceId
The ID of the source that was attributed the transaction
number
1234567
eventId
The event ID for the transaction
number
123456
eventName
The event name describes the transction that took place (this could be a subscription, product, or general sale)
string
A Sale Event
eventTypeId
This donates the type of transaction, where 4 = Lead (a transaction with no monetary value like a registration) and 5 = Sale
number
5
status
For transactions with a pending period this is the current status, where A = Accepted, P = Pending and D = Denied
string
A
timeofLastClick
The timestamp of the last click before the transaction was made
string
2019-02-18 19:07:59.0
timeofCreate
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
string
2019-02-27 00:38:28.0
timeofTransaction
The timestamp of when the transaction took place
string
2019-02-26 23:17:56.0
timeofLastModified
The timestamp of when the transaction was last changed. This is usually when the status after an advertiser validates transactions
string
null
epi
Enhanced Publisher Information (EPI) is a custom field for publishers to pass their own values, up to 64 bytes, this can be used for sub networks to pass their own internal IDs
string
1234A
epi2
Enhanced Publisher Information 2 (EPI2) is a second custom field for publishers to pass their own values, up to 64 bytes, this can be used for sub networks to pass their own internal IDs
string
ABC4321
leadNumber
When eventTypeId = 4 the leadNumber for the transaction
string
null
orderNumber
When eventTypeId = 5 the orderNumber for the transaction
string
order123
orderValue
When eventTypeId = 5 the order value for the transaction
number
100
commission
The commission attributed to the source for the transaction
number
10
paid
Whether the commission for the transaction has been assigned to a payment invoice and should have been paid to the publisher
string
false
productInfo
ProductInfo Object contains all products in the basket for the transaction if the adveriser supplies this data
object
voucherCode
The voucher code redeemed if it was used for the transaction
string
10PERCENT
productsApi
object
paymentId 1234567
If the transaction has been paid, the paymentId the transaction belongs to
number

List transaction by Payment

List of transactions for a given Payment Id

URI Parameters
paymentId	Filter by paymentId
reportCurrencyCode	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)

Response

object

transactionId
Unique ID for each transaction
number
99999888901
programId
The ID for the program where the transaction took place
number
123456
programName
The name of the program where the transaction took place
string
Program 1
sourceName
The name of the source that was attributed the transaction
string
Source 1
sourceId
The ID of the source that was attributed the transaction
number
1234567
eventId
The event ID for the transaction
number
123456
eventName
The event name describes the transction that took place (this could be a subscription, product, or general sale)
string
A Sale Event
eventTypeId
This donates the type of transaction, where 4 = Lead (a transaction with no monetary value like a registration) and 5 = Sale
number
5
status
For transactions with a pending period this is the current status, where A = Accepted, P = Pending and D = Denied
string
A
timeofLastClick
The timestamp of the last click before the transaction was made
string
2019-02-18 19:07:59.0
timeofCreate
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)
string
2019-02-27 00:38:28.0
timeofTransaction
The timestamp of when the transaction took place
string
2019-02-26 23:17:56.0
timeofLastModified
The timestamp of when the transaction was last changed (usually when the status after an advertiser validates transactions)
string
null
epi
Enhanced Publisher Information (EPI) is a custom field for publishers to pass their own values (up to 64 bytes), this can be used for sub networks to pass their own internal IDs
string
1234A
epi2
Enhanced Publisher Information 2 (EPI2) is a second custom field for publishers to pass their own values (up to 64 bytes), this can be used for sub networks to pass their own internal IDs
string
ABC4321
leadNumber
When eventTypeId = 4 (transaction is a lead) the leadNumber for the transaction
string
null
orderNumber
When eventTypeId = 5 (transaction is a sale) the orderNumber for the transaction
string
order123
orderValue
When eventTypeId = 5 (transaction is a sale) the order value for the transaction
number
100
commission
The commission attributed to the source for the transaction
number
10
paid
Whether the commission for the transaction has been assigned to a payment invoice and should have been paid to the publisher
string
false
productInfo
ProductInfo Object contains all products in the basket for the transaction if the adveriser supplies this data
object
voucherCode
The voucher code redeemed if it was used for the transaction
string
10PERCENT
productsApi
object
paymentId 1234567
If the transaction has been paid, the paymentId the transaction belongs to
number

Export Payment Transactions

Export list of transactions for a given payment Id

URI Parameters
paymentId	Filter by paymentId
format	Format of the export file
reportCurrencyCode	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

Response

object

transactionId
Unique ID for each transaction
number
99999888901
programId
The ID for the program where the transaction took place
number
123456
programName
The name of the program where the transaction took place
string
Program 1
sourceName
The name of the source that was attributed the transaction
string
Source 1
sourceId
The ID of the source that was attributed the transaction
number
1234567
eventId
The event ID for the transaction
number
123456
eventName
The event name describes the transction that took place (this could be a subscription, product, or general sale)
string
A Sale Event
eventTypeId
This donates the type of transaction, where 4 = Lead (a transaction with no monetary value like a registration) and 5 = Sale
number
5
status
For transactions with a pending period this is the current status, where A = Accepted, P = Pending and D = Denied
string
A
timeofLastClick
The timestamp of the last click before the transaction was made
string
2019-02-18 19:07:59.0
timeofCreate
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
string
2019-02-27 00:38:28.0
timeofTransaction
The timestamp of when the transaction took place
string
2019-02-26 23:17:56.0
timeofLastModified
The timestamp of when the transaction was last changed. This is usually when the status after an advertiser validates transactions
string
null
epi
Enhanced Publisher Information (EPI) is a custom field for publishers to pass their own values, up to 64 bytes, this can be used for sub networks to pass their own internal IDs
string
1234A
epi2
Enhanced Publisher Information 2 (EPI2) is a second custom field for publishers to pass their own values, up to 64 bytes, this can be used for sub networks to pass their own internal IDs
string
ABC4321
leadNumber
When eventTypeId = 4 the leadNumber for the transaction
string
null
orderNumber
When eventTypeId = 5 the orderNumber for the transaction
string
order123
orderValue
When eventTypeId = 5 the order value for the transaction
number
100
commission
The commission attributed to the source for the transaction
number
10
paid
Whether the commission for the transaction has been assigned to a payment invoice and should have been paid to the publisher
string
false
productInfo
ProductInfo Object contains all products in the basket for the transaction if the adveriser supplies this data
object
voucherCode
The voucher code redeemed if it was used for the transaction
string
10PERCENT
productsApi
object
paymentId 1234567
If the transaction has been paid, the paymentId the transaction belongs to
number

Dashboard

Collection of summary reports

Summary statistics

Summary statistics used for the dashboard within the publisher interface.

URI Parameters
dateRange	Date range for the report

Top performing programs

Provides summary statistics sorted for top performing programs

URI Parameters
dateRange	Date range for the report
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

Top performing sources

Provides summary statistics sorted for top performing sources

URI Parameters
dateRange	Date range for the report
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

Payment

Reports related to payment and commission earned

List Payments

Lists payments made to the publisher

URI Parameters
fromDate	The date the report runs from
toDate	The date the report runs until
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

Payment Detail

Get detailed information about a payment

Account Balance Breakdown

Breakdown of earned commission by program and seperated into three objects:

amountReadyForPayment: commission that is ready to be paid on next payment date
pendingEarnings: approved commission but not ready for payment
unapprovedBalance: commission in a pending state

Pending Earnings Breakdown

Breakdown of commission not approved for payment. This is split into two objects

amountReadyForPayment: commission that has been approved but is unable to be paid for other reasons such as:
- Empty bank details
- Network quality payment block
- Market minimum payment limit has not been reached
amountNotReadyForPayment: commission in a pending state

Earnings

Overall earnings for a publisher broken down by pending approval and the amount to be paid and on which date.

amountToBePaid: the amount that a publisher will be paid on the next payment date.
pendingEarnings: the amount that has been approved but not yet ready for payment (i.e. an advertiser hasn't yet paid the invoice).
balance: the total amount of commission a publisher has earned that has yet to be paid (including amountToBePaid, pendingEarnings and any non-approved leads or sales).

Digital Wallets

Digital wallets are manual payments that are assigned to a publisher. These can relate to bonuses, tenancy placements or commission corrections.

URI Parameters
programId	Filter by programId
sourceId	Filter by sourceId
fromDate	Filter by date the digital wallet was created
toDate	Filter by date the digital wallet was created
reportCurrencyCode	The ISO 4217 code of currency
status	Status of the digital wallet - has it been invoiced to an advertiser and has it been paid.
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

Response

object

programId
The ID for the program where the transaction took place
number
123456
programName
The name of the program where the transaction took place
string
Program 1
sourceName
The name of the source that was attributed the transaction
string
Source 1
sourceId
The ID of the source that was attributed the transactio
number
1234567
createdDate
When the digital wallet was created in our database.
string
2019-01-01 09:38:28.0
text
Text to explain what the digital wallet relates to
string
Tenancy Placement Jan 2019
digitalWalletType
Whether the digital wallet is a deposit (positive amount to the publisher) or withdraw (correction to the publisher)
string
DEPOSIT
amount
Amount Object contains the amount in the publishers reporting currency and the program currency
object