advertiser/report/transaction-summary
The publisher performance report resource displays the publisher performance 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 year |
yyyy-mm-dd | N/A | Yes |
| publisherId | Publisher id | * 123 | N/A | No |
| groupId | Publisher group id | * 123 | N/A | No |
| state | Publisher state | * PA, MT, OH, WY, etc... | N/A | No |
| groupBy | Optional grouping | publisher, date, publisher_date, publisher_refurl | publisher | No |
| Response Fields | ||||
| Field | Description | Notes | ||
| publisher_id | Publisher id | This field is displayed only when grouping by publisher, publisher_date, or publisher_refurl | ||
| date | Date | This field is displayed only when grouping by date or publisher_date | ||
| impressions | Impression count | |||
| clicks | Click count | |||
| sales | Sale amount | |||
| leads | Leads count | |||
| sale_lead_amount | Sale + Lead amount | |||
| earnings_per_click | Earnings per click | |||
| bonus_amount | The sum of the publisher and site commission amounts for bonus transactions. | |||
| total_commission | The sum of the publisher and site commission amounts for non-bonus transactions. | |||
| publisher_bonus | The sum of the publisher commission amounts for bonus transactions. | |||
| publisher_commission | The sum of the publisher commission amounts for non-bonus transactions. | |||
| site_bonus | The sum of the site commission amounts for bonus transactions. | |||
| site_commission | The sum of the site commission amounts for non-bonus transactions. | |||
| publisher | Publisher name | This field is displayed only when grouping by publisher, publisher_date, or publisher_refurl | ||
| company | Publisher company | This field is displayed only when grouping by publisher, publisher_date, or publisher_refurl | ||
| state | Publisher state | This field is displayed only when grouping by publisher, publisher_date, or publisher_refurl | ||
| website | Website URL | This field is displayed only when grouping by publisher, publisher_date, or publisher_refurl | ||
| publisher_referral_url | URL that drove the traffic and conversions specified by the Publisher. | This field is displayed only when grouping by publisher_refurl | ||
| 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.