advertiser/report/transaction-details
The transaction details report resource displays all publisher transactions 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 6 months |
yyyy-mm-dd | N/A | Yes |
| publisherId | Publisher id | * 123 | N/A | No |
| creativeId | Creative id | * 123 | N/A | No |
| groupId | Publisher group id | * 123 | 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 |
| orderId | Order id | * Any generic string | N/A | No |
| includeCoupons | If included, reports will contain the coupons field. | 1,true | 0,false | No |
| deviceType | If included, reports will contain the device type. | 1,true | 0,false | No |
| clickId | If included, reports will contain the click id. | 1,true | 0,false | No |
| clickDate | If included, reports will contain the click date. | 1,true | 0,false | No |
| referrerUrl | If included, reports will contain the referrer url. | 1,true | 0,false | No |
| newToFile | Filters transactions to show new to file or not new to file Available for Dynamic Tracking only. |
'yes', 'no' | N/A | No |
| Response Fields | ||||
| Field | Description | Notes | ||
| transaction_id | Transaction id | |||
| creative_id | Creative id | |||
| order_id | Order id | |||
| publisher_id | Publisher id | |||
| link_type | Link type | |||
| new_to_file | New to file | Available for Dynamic Tracking only | ||
| transaction_type | Transaction type | |||
| sale_amount | Sale amount | |||
| commission | Commission amount | |||
| commission_publisher | Publisher Commission | |||
| commission_site | Site Commission | |||
| sale_date | Sale date | |||
| status | Status | |||
| publisher | Publisher name | |||
| company | Publisher company | |||
| group_id | Publisher group id | This field will be displayed only if groupId parameter is provided | ||
| coupons (optional) | Coupon codes sent with the transaction | Available for Dynamic Tracking only | ||
| device_type (optional) | Device Type | one of: mobile, tablet, desktop | ||
| publisher_referral_url | URL that drove the traffic and conversions specified by the Publisher. | This field is displayed only when grouping by publisher_refurl | ||
| click_id (optional) | Click Id | The attributed click id of the transaction | ||
| click_date (optional) | Click Date | The date when the click occurred | ||
| referrer_url (optional) | Referrer Url | URL that drove the traffic and conversions | ||
* Values shown are placeholder values. Please replace with actual data.