advertiser/report/creative-details
The creative performance report resource displays the creative 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 |
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, printable, in-store | N/A | No |
groupBy | Optional grouping | publisher, date, publisher_date | N/A | No |
Response Fields | ||||
Field | Description | Notes | ||
creative_id | Creative id | |||
creative_type | Creative type | |||
creative_name | Creative name | This field will only be populated with link types of text, advanced, banner, or contextual. | ||
date | Date | This field will only be displayed when grouping by date, publisher_date | ||
publisher_id | Publisher ID | This field will only be displayed when grouping by publisher, publisher_date | ||
publisher | Publisher name | This field will only be displayed when grouping by publisher, publisher_date | ||
affiliate_usage | Affiliate usage | |||
impressions | Impressions count | |||
items | Item count | |||
clicks | Click count | |||
click_through_rate | Clickthrough rate | |||
commission | Commission amount | |||
sales | Sale amount | |||
earnings_per_click | Earnings per click | |||
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.