advertiser/report/transaction-history
The transaction history report resource displays all publisher transaction history within a given year time frame.
| GET | ||||
|---|---|---|---|---|
| Request Parameters | ||||
| Parameter | Description | Possible Values | Default | Required? |
| startDate | A valid date string in the ISO 8601 date format; any timestamp information that is present will be ignored | yyyy-mm-dd | N/A | Yes |
| endDate | A valid date string in the ISO 8601 date format; any timestamp information that is present will be ignored PLEASE NOTE: The period of time formed by the start date and the end date must not exceed 1 month |
yyyy-mm-dd | N/A | Yes |
| publisherId | Publisher id | * 123 | N/A | No |
| groupId | Publisher group id | * 123 | N/A | No |
| transactionType | Transaction type | sale, lead, bonus, click | N/A | No |
| orderId | Order id | * Any generic string | N/A | No |
| creativeType | Creative Type | product, text, advanced, banner, contextual, newsletter, manual, generic, call, aggregate, skimlinks | N/A | No |
| advancedSubType | Advanced Sub-type PLEASE NOTE: Use this parameter in conjunction with creativeType=advanced |
html, flash, email, coupon | N/A | No |
| itemId | Item id | * Any generic string | N/A | No |
| adjustmentType | When this parameter is set, transaction history will be limited to records with negative adjustments (debits) or positive adjustments (credits) | credit,debit | N/A | No |
| groupByPublisher | When this parameter is set, transaction history will be grouped by publisher | 1,true | N/A | No |
| separateCommission | When this parameter is set, transaction history will have two additional fields showing publisher_commission and site_commission | 1 | N/A | No |
| Response Fields | ||||
| Field | Description | Notes | ||
| publisher_id | Publisher id | |||
| transaction_id | Transaction id | This field will not be displayed if groupByPublisher parameter is set | ||
| sale_date | Sale date | This field will not be displayed if groupByPublisher parameter is set | ||
| order_id | Order id | This field will not be displayed if groupByPublisher parameter is set | ||
| status | Status | This field will not be displayed if groupByPublisher parameter is set | ||
| link_type | Link type | This field will not be displayed if groupByPublisher parameter is set | ||
| transaction_type | Transaction type | This field will not be displayed if groupByPublisher parameter is set | ||
| commission | Total commission amount | |||
| publisher_commission | Commission received by the publisher | PLEASE NOTE: This field is only shown when 'separateCommission' parameter is used |
||
| site_commission | Commission received by the network | PLEASE NOTE: This field is only shown when 'separateCommission' parameter is used |
||
| sale_amount | Sale amount | |||
| process_date | Process date | This field will not be displayed if groupByPublisher parameter is set | ||
| item_id | Item id | This field will not be displayed if groupByPublisher parameter is set | ||
| publisher | Publisher name | |||
| company | Publisher company | |||
| website_url | Website URL | This field will not be displayed if groupByPublisher parameter is set | ||
| revision | Revision number of the history record | This field will not be displayed if groupByPublisher parameter is set | ||
| group_id | Publisher group id | This field will be displayed only if groupId parameter is provided | ||
* Values shown are placeholder values. Please replace with actual data.