getFeedbackRatingSummary: eBay Feedback API

GET/feedback_rating_summary

This method provides a detailed overview of feedback ratings associated with a user in the eBay marketplace. Specify a user ID and apply filters to retrieve summarized feedback data categorized by rating types and user roles. These returned metrics are aggregated, which offers insight into user experiences and performance.

Tip: You can use this method to help sellers and buyers understand their marketplace reputation and identify areas for improvement.

Returned data provides a summary of feedback ratings for a user by rating type (such as overall experience, communication, or delivery timeliness) for both buyer and seller roles. Each type of rating includes aggregated metrics like averages, counts, unique feedback givers, and the percentage of positive ratings (excluding neutrals). The response also details the distribution of specific rating values, their frequency, and time period (with period units like days or months) over which these metrics were calculated.

Input

Resource URI

GET https://api.ebay.com/commerce/feedback/v1/feedback_rating_summary?

user_id=string&

filter=string

This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com

URI parameters

Parameter	Type	Description
user_id	string	Use this parameter to specify the unique identifier (the eBay username associated with the account) for the eBay user whose feedback summary is being retrieved. Occurrence: Required
filter	string	Use this parameter to limit the response based on specified filter values: ratingType: Specifies the type of rating being summarized and returned (Required). Available values: `OVERALL_EXPERIENCE`, `OVERALL_EXPERIENCE_COMMENT`, `ON_TIME_DELIVERY`, `DSR_ITEM_AS_DESCRIBED`, `DSR_COMMUNICATION`, `DSR_SHIPPING_CHARGES`, `DSR_SHIPPING_TIME`, `ITEM_RATING` See FeedbackRatingTypeEnum for descriptions of values. excludeRepeatFeedback: Set to `true` to exclude repeat feedback. lookbackPeriodInDays: Limit the response to a previous period of days. Available values: `7`, `30`, `90`, `180`, or `365` You can send the filter as a query parameter, either with the required ratingType only, or combining the filter values with a comma-separated name:value list. For example: `filter=ratingType:OVERALL_EXPERIENCE,excludeRepeatFeedback:true,period:365` Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.

OAuth scope

This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope/commerce.feedback.readonly

See OAuth access tokens for more information.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

This call has no response headers.

Response payload

Copy complete valid JSON to clipboard

{ /* GetFeedbackRatingSummaryResponse */

"feedbackRatingSummary" : [

{ /* FeedbackRatingSummary */

"ratingSummaryByRatingType" : [

{ /* RatingSummaryByRatingType */

"feedbackMetrics" : [

{ /* FeedbackMetrics */

"metricName" : "FeedbackAggregationTypeEnum : [AVG,COUNT,UNIQUE_PROVIDER_COUNT...]",

"metricValue" : "number"

}

"feedbackRatingValueDistribution" : [

{ /* FeedbackRatingValueDistribution */

"count" : "integer",

"value" : "string"

}

"period" :

{ /* Period */

"unit" : "string",

"value" : "integer"

"userRoleType" : "UserRoleEnum : [SELLER,BUYER]"

}

"ratingType" : "FeedbackRatingTypeEnum : [OVERALL_EXPERIENCE,OVERALL_EXPERIENCE_COMMENT,ON_TIME_DELIVERY...]"

}

]

}

Response fields

Output container/field	Type	Description
feedbackRatingSummary	array of FeedbackRatingSummary	An array containing a summary of feedback ratings. Each element provides detailed metrics and distributions for specific rating types. Occurrence: Conditional
feedbackRatingSummary.ratingSummaryByRatingType	array of RatingSummaryByRatingType	An array that includes metrics and distributions for each rating type. Occurrence: Conditional
feedbackRatingSummary.ratingSummaryByRatingType.feedbackMetrics	array of FeedbackMetrics	An array of metrics associated with feedback aggregation. Occurrence: Conditional
feedbackRatingSummary.ratingSummaryByRatingType.feedbackMetrics.metricName	FeedbackAggregationTypeEnum	This enumerated value specifies the type of feedback aggregation. For example, `AVG` would indicate the feedback returned represents the average value of the feedback. See metricValue for the value of the returned feedback. Occurrence: Conditional
feedbackRatingSummary.ratingSummaryByRatingType.feedbackMetrics.metricValue	number	The decimal value of the specified metric. For example, 55.8 would represent a value associated with the metricName (see metricName for interpretation and units). Occurrence: Conditional
feedbackRatingSummary.ratingSummaryByRatingType.feedbackRatingValueDistribution	array of FeedbackRatingValueDistribution	An array listing the distribution values of the feedback ratings. Occurrence: Conditional
feedbackRatingSummary.ratingSummaryByRatingType.feedbackRatingValueDistribution.count	integer	An integer representing the number of occurrences for a specific feedback rating value. For example, for the `POSITIVE` value, a `3` returned as the count represents three positive ratings were returned. Occurrence: Conditional
feedbackRatingSummary.ratingSummaryByRatingType.feedbackRatingValueDistribution.value	string	A string indicating the specific feedback rating value. Supported values include: `POSITIVE`, `NEUTRAL`, `NEGATIVE`, `1`, `2`, `3`, `4`, and `5`. Occurrence: Conditional
feedbackRatingSummary.ratingSummaryByRatingType.period	Period	The time period on which the feedback summary is calculated. Occurrence: Always
feedbackRatingSummary.ratingSummaryByRatingType.period.unit	string	The unit of the period's value. Supported value: `DAY`. Occurrence: Always
feedbackRatingSummary.ratingSummaryByRatingType.period.value	integer	The value for the feedback period, specified in units of unit. Supported value: `90`. Occurrence: Always
feedbackRatingSummary.ratingSummaryByRatingType.userRoleType	UserRoleEnum	This enumerated value indicates the user's role in the feedback (`BUYER` or `SELLER`). Occurrence: Always
feedbackRatingSummary.ratingType	FeedbackRatingTypeEnum	This enumerated value indicates the type of rating being summarized. For example, `OVERALL_EXPERIENCE` indicates the rating applies to the overall transaction experience. Occurrence: Always

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

Status	Meaning
200	Success
400	Bad Request
401	Not Authorized
404	Not Found
500	Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

Code	Domain	Category	Meaning
501002	API_FEEDBACK	REQUEST	Unsupported request parameter combination.
501007	API_FEEDBACK	REQUEST	Seller ratings are not valid type.
501022	API_FEEDBACK	REQUEST	Rating type request parameter is invalid.
501023	API_FEEDBACK	APPLICATION	Feedback rating summary user not found.
501037	API_FEEDBACK	REQUEST	Invalid period value. Must be 30, 60, or 365.

Warnings

This call has no warnings.

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Get Feedback Rating Summary

This call retrieves a detailed overview of feedback ratings associated with the specified user filtering for the type of rating (this sample uses OVERALL_EXPERIENCE) and period in the eBay marketplace.

Input

The input specifies the user ID, type of rating, and period and excludes repeat feedback.

GEThttps://api.ebay.com/commerce/feedback/v1/feedback_rating_summary?user_id=sd*********er&filter=ratingType:OVERALL_EXPERIENCE,period:365,excludeRepeatFeedback:true

Output

If the call is successful, an array of feedback ratings matching the specified criteria are returned.

{
   "feedbackRatingSummary": [
       {
           "ratingType": "OVERALL_EXPERIENCE",
           "ratingSummaryByRatingType": [
               {
                   "period": {
                       "value": 365,
                       "unit": "DAY"
                   },
                   "feedbackMetrics": [
                       {
                           "metricName": "POSITIVE_PERCENT_EXCLUDING_NEUTRAL_FEEDBACK",
                           "metricValue": 55.8
                       }
                   ],
                   "feedbackRatingValueDistribution": [
                       {
                           "value": "POSITIVE",
                           "count": 29
                       },
                       {
                           "value": "NEUTRAL",
                           "count": 28
                       },
                       {
                           "value": "NEGATIVE",
                           "count": 23
                       }
                   ]
               },
               {
                   "period": {
                       "value": 365,
                       "unit": "DAY"
                   },
                   "userRoleType": "BUYER",
                   "feedbackRatingValueDistribution": [
                       {
                           "value": "POSITIVE",
                           "count": 0
                       },
                       {
                           "value": "NEUTRAL",
                           "count": 0
                       },
                       {
                           "value": "NEGATIVE",
                           "count": 0
                       }
                   ]
               },
               {
                   "period": {
                       "value": 365,
                       "unit": "DAY"
                   },
                   "userRoleType": "SELLER",
                   "feedbackMetrics": [
                       {
                           "metricName": "POSITIVE_PERCENT_EXCLUDING_NEUTRAL_FEEDBACK",
                           "metricValue": 55.8
                       }
                   ],
                   "feedbackRatingValueDistribution": [
                       {
                           "value": "POSITIVE",
                           "count": 29
                       },
                       {
                           "value": "NEUTRAL",
                           "count": 28
                       },
                       {
                           "value": "NEGATIVE",
                           "count": 23
                       }
                   ]
               }
           ]
       }
   ]
}