EN - Transactions API
- Christian Goerke
- Thomas Goschnick
The Transaction API is used to retrieve transaction data. For this purpose, the following parameter must be appended to the API call:
API | Parameter |
|---|---|
Transaktionen | get-orders |
Example: https://www.domain.de/api//ACCESS-TOKEN/admin/ID/get-orders.csv
The Transaction API provides access to a range of additional parameters that can be utilized for querying purposes. Below is a comprehensive list of these parameters:
status of transaction
Parameter | Value | Description | Example |
|---|---|---|---|
condition[l:status] | open | All transaction that have the status “open” in the system | condition[I:status]=open |
| confirmed | All transaction that have the status “confirmed” in the system | condition[I:status]=confirmed |
| paid | All transaction that have the status “paid” in the system | condition[I:status]=paid |
| canceled | All transaction that have the status “cancelled” in the system | condition[I:status]=canceled |
Note: A combination of multiple statuses is possible. For example:
condition[l:status]=confirmed,paid
additional filter
Parameter | Value | Description | Example |
|---|---|---|---|
condition[l:publisher] | Numerical value corresponding to the publisher.
| All transactions that have been assigned with the respective publisher | condition[l:publisher]=1001 |
condition[l:mandant] | Numerical value corresponding to the client. | All transactions that have been assigned with the respective client | condition[l:mandant]=1 |
condition[l:advertiser] | Numerical value corresponding to the advertiser id. | All transactions that have been assigned with the respective advertiser | condition[l:advertiser]=1 |
condition[l:projects] | Numerical value corresponding to the project. | All transactions that have been assigned with the respective projects | condition[l:projects]=50001 |
condition[l:campaigns] | Numerical value corresponding to the campaigns. | All transactions that have been assigned with the respective campaigns | condition[l:campaigns]=1 |
[datemode] | incoming = transaction date processing = processing date payout = payout date | All transactions that have been created/processed/paid within a specific time period.
| [datemode]=processing |
Definitions of columns names
id | Unique ID of the transaction |
status | Status of the transaction |
timestamp | Transaction date of the transaction |
campaign_id | Campaign ID to which the transaction is assigned. |
attribution | attribution value |
delivered_tagcode_count | delivered tag codes |
delivered_tagcode_serversided_url | delivered serversided tracking call |
ordertoken | order number |
source | source of transaction |
project_id | project id to which the transaction is assigned. |
admedia_id | ad media id to which the transaction is assigned. |
type | kind of transaction - e.g sale or lead |
commission | commission of transaction |
source_commission |
|
commission_group_id | commission group id in which the project was located when the transaction was generated. |
trigger_id | trigger id to which the transaction is assigend |
description | Additional information that was passed in tracking when the transaction occurred (optional). |
trigger_value | The amount of commission, used for calculation the commission. |
trigger_type | type of trigger (e.g fixed commission, percentage commission) |
turnover | Revenue of transaction |
attributed_turnover |
|
zone_id |
|
zone_name |
|
original_turnover | Revenue in advertiser currency |
action_id | Action ID to which the transaction is assigned |
salary_id | ID of payout process in whicht the transaction was paid out. |
salary_timestamp |
|
session_id | Session ID to which the transaction is assigned |
order_currency | order currency |
status_change_date | For transaction status changes, this value is adjusted to the corresponding date |
cancel_reason | cancel reason |
source_turnover | initial turnover of transaction |
last_change | timestamp of last transaction modification |
user_agent | User Agent |
order_actions_id | internal reference to the commission-relevant click / postview. |
bonus_id | Bonus ID |
customer_journey_status | internal kpi |
ebestid | hashed order number shown in publisher area |
order_timestamp | timestamp of transaction |
action_timestamp | timestamp of click / postview |
trigger_title | name of the trigger |
payoutdate | payout date |
campaign_group_title | title of the commission group |
project_title | name of the project |
campaign_title | name of the campaign |
advertiser_id | id of the advertiser |
advertiser_title |
|
publisher_id | id of the publisher |
referrer | The page where the click was generated that later resulted in the transaction. |
country | country the transaction was generated |
subid | subid |
publisher_prename | prename of the publisher |
publisher_surname | surname of the publisher |
publisher_searchtitle | searchtitle fhe publisher |
publisher_telefone |
|
publisher_dialog_email |
|
basket_items | amount of articles in basket |
external_sources_entity_id |
|
external_sources_currency_code |
|
external_sources_currency_rate |
|
external_sources_turnover |
|
source_project_id |
|
source_project_title |
|
order_request_id |
|
turnover_brutto |
|