HomeDocumentationCode SamplesAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
Documentation
Developer HubAPI StatusSupport

Performance Reports

Performance Reports for the Selling Partner Reports API.

Flat File Feedback Report

reportType Value: GET_SELLER_FEEDBACK_DATA

Role: Selling Partner Insights, Amazon Fulfillment

Availability: Sellers

Requested/scheduled: This report can only be requested.

Report output type: Tab-delimited flat file

Contains negative and neutral feedback (one to three stars) from buyers who rated the seller's performance.

Select to expand list of report attributes.
  • Date
  • Rating
  • Comments
  • Your Response
  • Order ID
  • Rater Email

XML Customer Metrics Report

reportType Value: GET_V1_SELLER_PERFORMANCE_REPORT

Role: Selling Partner Insights

Availability: Sellers

Requested/scheduled: This report can only be requested.

Report output type: XML

Contains select, individual performance metrics data from the Seller Central dashboard.

Select to expand list of report attributes.
  • performanceChecklist
  • orderDefectRate
  • orderDefectMetrics
  • timeFrame
  • orderCancellationRate
  • lateShipmentRate
  • policyViolation
  • onTimeDelivery
  • onTimeDelivery
  • validTrackingRate
  • contactResponseTime
  • returnDissatisfactionRate
  • customerServiceDissatisfactionRate
  • productAuthenticityStatus
  • productSafetyStatus listingPolicyStatus
  • intellectualPropertyStatus
  • orderCount
  • orderWithDefects
  • negativeFeedbacks
  • a_z_claims
  • chargebacks
  • customerExperience
    • customerExperienceMetrics
    • lateShipment
    • preFulfillmentCancellation
    • refunds
  • buyerSellerContactResponseTimeMetrics
    • averageResponseTimeInHours
    • responseUnder24Hours
    • responseTimeGreaterThan24Hours
    • noResponseForContactsOlderThan24Hours

Seller Performance Report

reportType Value: GET_V2_SELLER_PERFORMANCE_REPORT

Role: Selling Partner Insights

Availability: Sellers

Requested/scheduled: This report can only be requested.

Contains the individual performance metrics data from the Seller Central Account Health dashboard.

Select to expand list of report attributes.
  • accountStatuses
    • marketplaceId
    • status
  • performanceMetrics
    • lateShipmentRate
      • reportingDateRange
        • reportingDateFrom
        • reportingDateTo
      • status
      • targetValue
      • targetCondition
      • orderCount
      • lateShipmentCount
      • rate
    • invoiceDefectRate
      • reportingDateRange
        • reportingDateFrom
        • reportingDateTo
      • status
      • targetValue
      • targetCondition
      • invoiceDefect
        • status
        • count
      • missingInvoice
        • status
        • count
      • lateInvoice
        • status
        • count
      • orderCount
      • rate
    • orderDefectRate
      • afn
        • reportingDateRange
          • reportingDateFrom
          • reportingDateTo
        • status
        • targetValue
        • targetCondition
        • orderWithDefects
          • status
          • count
        • claims
          • status
          • count
        • chargebacks
          • status
          • count
        • negativeFeedback
          • status
          • count
        • negativeFeedback
          • status
          • count
        • orderCount
          • rate
          • fulfillmentType
      • mfn
        • orderWithDefects
          • status
          • count
        • claims
          • status
          • count
        • chargebacks
          • status
          • count
        • negativeFeedback
          • status
          • count
        • negativeFeedback
          • status
          • count
        • orderCount
          • rate
          • fulfillmentType
    • onTimeDeliveryRate
      • reportingDateRange
        • reportingDateFrom
        • reportingDateTo
      • status
      • targetValue
      • targetCondition
      • shipmentCountWithValidTracking
      • onTimeDeliveryCount
      • rate
    • validTrackingRate
      • reportingDateRange
        • reportingDateFrom
        • reportingDateTo
      • status
      • targetValue
      • targetCondition
      • shipmentCount
      • validTrackingCount
      • rate
    • preFulfillmentCancellationRate
      • reportingDateRange
        • reportingDateFrom
        • reportingDateTo
      • status
      • targetValue
      • targetCondition
      • orderCount
      • cancellationCount
      • rate
    • warningStates
      • accountHealthRating
        • ahrStatus
        • reportingDateRange
          • reportingDateFrom
          • reportingDateTo
      • listingPolicyViolations
        • reportingDateRange
          • reportingDateFrom
          • reportingDateTo
        • status
        • targetValue
        • targetCondition
        • defectsCount
      • productAuthenticityCustomerComplaints
        • reportingDateRange
          • reportingDateFrom
          • reportingDateTo
        • status
        • targetValue
        • targetCondition
        • defectsCount
      • productConditionCustomerComplaints
        • reportingDateRange
          • reportingDateFrom
          • reportingDateTo
        • status
        • targetValue
        • targetCondition
        • defectsCount
      • productSafetyCustomerComplaints
        • reportingDateRange
          • reportingDateFrom
          • reportingDateTo
        • status
        • targetValue
        • targetCondition
        • defectsCount
      • receivedIntellectualPropertyComplaints
        • reportingDateRange
          • reportingDateFrom
          • reportingDateTo
        • status
        • targetValue
        • targetCondition
        • defectsCount
      • restrictedProductPolicyViolations
        • reportingDateRange
          • reportingDateFrom
          • reportingDateTo
        • status
        • targetValue
        • targetCondition
        • defectsCount
      • suspectedIntellectualPropertyViolations
        • reportingDateRange
          • reportingDateFrom
          • reportingDateTo
        • status
        • targetValue
        • targetCondition
        • defectsCount
      • foodAndProductSafetyIssues
        • reportingDateRange
          • reportingDateFrom
          • reportingDateTo
        • status
        • targetValue
        • targetCondition
        • defectsCount
      • customerProductReviewsPolicyViolations
        • reportingDateRange
          • reportingDateFrom
          • reportingDateTo
        • status
        • targetValue
        • targetCondition
        • defectsCount
      • otherPolicyViolations
        • reportingDateRange
          • reportingDateFrom
          • reportingDateTo
        • status
        • targetValue
        • targetCondition
        • defectsCount

Promotions Performance Report

reportType Value: GET_PROMOTION_PERFORMANCE_REPORT

Role: Selling Partner Insights, Brand Analytics

Availability: 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.

Requested/scheduled: This report can only be requested.

Report output type: JSON

Contains 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.
{
  "reportSpecification":{
    "reportType":"GET_PROMOTION_PERFORMANCE_REPORT
        reportOptions":{
      "promotionStartDateFrom
            promotionStartDateTo"
    },
    "marketplaceIds"
  },
  "promotions":[
    {
      "promotionId
            promotionName
            marketplaceId
            merchantId
            type
            status
            glanceViews
            unitsSold
            revenue
            revenueCurrencyCode
            startDateTime
            endDateTime
            createdDateTime
            lastUpdatedDateTime
            includedProducts":[
        {
          "asin
                    productName
                    productGlanceViews
                    productUnitsSold
                    productRevenue
                    productRevenueCurrencyCode"
        }
      ]
    }
  ]
}

Coupons Performance Report

reportType Value: GET_COUPON_PERFORMANCE_REPORT

Schema: sellerCouponReport, vendorCouponReport

Role: Brand Analytics

Availability: Sellers and Vendors

Requested/scheduled: This report can only be requested.

Report output type: JSON

Contains 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.
Select to expand list of report attributes.
  • marketplaceIds
  • coupons