Developer HubAPI StatusSupport

Performance Report Type Values

The available Performance Report Type Values for the Selling Partner Reports API.

Name Description

Flat File Feedback Report

reportType value:
GET_SELLER_FEEDBACK_DATA

For all sellers.

Tab-delimited flat file report that contains negative and neutral feedback (one to three stars) from buyers who rated the seller's performance.

Can be requested.

XML Customer Metrics Report

reportType value:
GET_V1_SELLER_PERFORMANCE_REPORT

For all sellers.

XML report that contains select, individual performance metrics data from the Seller Central dashboard.

Can be requested.

Seller Performance Report

reportType value:
GET_V2_SELLER_PERFORMANCE_REPORT

For all sellers.

Report that contains the individual performance metrics data from the Seller Central Account Health dashboard.

Can be requested

Promotions Performance Report

reportType value:
GET_PROMOTION_PERFORMANCE_REPORT

Available to sellers who have the Selling Partner Insights Selling Partner API role and vendors who have the Brand Analytics Selling Partner API role who are also registered in Amazon's Brand Registry.

JSON report containing data from promotion campaigns to help sellers and vendors optimize their promotions and adjust their advertising strategies. The report includes sales from promotions, the types of discounts that were offered, and how many items were sold as a result of the promotions. Currently, three promotion types are supported for vendors (Best Deal, Lightning Deal, and Price Discount), and two promotion types are supported for sellers (Best Deal and Lightning Deal).

This report accepts the following reportOptions values:

  • promotionStartDateFrom. The start of a date and time range (in ISO 8601 date time format) used for selecting promotions to report on. Be sure to specify the time zone: either UTC or an offset from UTC.
  • promotionStartDateTo. The end of a date and time range (in ISO 8601 date time format) used for selecting promotions to report on. Be sure to specify the time zone: either UTC or an offset from UTC.
    Example:
    "reportOptions": {"promotionStartDateFrom": "2020-11-23T15:33:26Z", "promotionStartDateTo": "2020-12-06T15:33:26Z" }

Requests must include the promotionStartDateFrom and promotionStartDateTo in the reportOptions. All promotions with a start date-time that fall within the range of promotionStartDateFrom and promotionStartDateTo will be included.

Report behaviors:

  • If a selected promotion is in progress when you request a report, the report will contain cumulative data for the promotion up until the day prior to your report request.
  • A report will contain complete information on a selected promotion if the promotion ended one day or more before the time you requested the report.
  • This report supports start dates up to two years before the current date.
  • Data for this report is updated on a daily basis, so some fields might not reflect the most up-to-date state of the promotion.

Can be requested by both sellers and vendors.

Coupons Performance Report

reportType value:
GET_COUPON_PERFORMANCE_REPORT

Schemas:sellerCouponReport

vendorCouponReport

Available to sellers and vendors who have the Brand Analytics Selling Partner API role.

JSON report containing data from coupon campaigns to help vendors optimize their promotions and adjust their advertising strategies. The report includes campaign-level details (total clips, redemptions) and coupon-level details (start/end date, clips, redemptions, and budget information).

This report accepts the following reportOptions values:

  • campaignStartDateFrom. The start of a date and time range in ISO 8601 date time format used for selecting coupon campaigns to report on. Be sure to specify the time zone: either UTC or an offset from UTC.
  • campaignStartDateTo. The end of a date and time range in ISO 8601 date time format used for selecting coupon campaigns to report on. Be sure to specify the time zone: either UTC or an offset from UTC.

Example:
"reportOptions": {"campaignStartDateFrom": "2020-11-23T15:33:26Z","campaignStartDateTo": "2020-12-06T15:33:26Z"}

Requests must include the campaignStartDateFrom and campaignStartDateTo in the reportOptions. All campaigns with a start date-time that fall within the range of campaignStartDateFrom and campaignStartDateTo will be included. The start date-time of a campaign is considered to be the earliest start date-time of any of its coupons.

Report behaviors:

  • If a selected campaign is in progress when you request a report, the report will contain cumulative data for the campaign up until the day prior to your report request.
  • A report will contain complete information on a selected campaign if the campaign ended one day or more before the time you requested the report.
  • This report supports start dates up to two years before the current date.
  • Data for this report is updated on a daily basis, so some fields might not reflect the most up-to-date state of the campaign.

Can be requested.

Updated 9 days ago