Use this method to retrieve a seller's performance and rating for the customer service metric.
Control the response from the getCustomerServiceMetric method using the following path and query parameters:
This method is supported in Sandbox environment. To access the endpoint, just replace the
api.ebay.com root URI with
|customer_service_metric_type||CustomerServiceMetricTypeEnum||Use this path parameter to specify the type of customer service metrics and benchmark data you want returned for the seller. Supported types are: |
|evaluation_type||EvaluationTypeEnum||Use this path parameter to specify the type of the seller evaluation you want returned, either: |
|evaluation_marketplace_id||MarketplaceIdEnum||Use this query parameter to specify the Marketplace ID to evaluate for the customer service metrics and benchmark data. |
For the list of supported marketplaces, see Analytics API requirements and restrictions.
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.
This request requires an access token created with the authorization code 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):
See OAuth access tokens for more information.
This call has no payload.
This call has no field definitions.
This call has no response headers.
|dimensionMetrics||array of DimensionMetric|
This container provides a seller's customer service metric performance for a given dimension.
This type defines the "dimension," or attributes, against which the associated customer service metric values and benchmark ratings are based.
dimensionKey defines the basis against which the seller's customer service metric is measured.
The dimension name returned in this field depends on the dimensionKey:
The value returned in this field depends on the dimensionKey.
|dimensionMetrics.metrics||array of Metric|
This is a list of Metric elements where each element contains data and information related to the transactions grouped by the associated dimension.
This complex type defines a set of benchmark data, which includes the average rating for the group included in the benchmark evaluation and the seller's calculated customer service metric rating for the benchmark.
If this field is present, it indicates that the rating given to the seller was "adjusted" for one reason or another.
This field returns the "basis" by which the benchmark is calculated for the customer service metric type.
This field contains the benchmark data.
This field returns the average value for the group, as defined by the specified basis.
This field returns seller's rating for the customer service metric.
|dimensionMetrics.metrics.distributions||array of MetricDistribution|
Returned when metricKey equals
This field returns the basis, or the method, by which the metric rating is calculated.
|dimensionMetrics.metrics.distributions.data||array of Distribution|
This field returns a list of name/value pairs, where the name indicates the distribution being rated and the value indicates the count of seller transactions that meet the distribution criteria.
The name of a distribution in which the seller is active.
This field contains the number of transactions the seller had in the distribution (identified by the associated name field) during the metric evaluationCycle.
This field indicates the customer service metric being returned in the associated metrics container. The field is set as follows:
This field is set to the seller's numeric rating for the associated metricKey for the given dimension during the evaluationCycle.
This complex type defines the evaluation type (
End date and time of the transaction lookback range. All timestamps are based on Mountain Standard Time (MST).
The ISO-8601 date and time at which the seller was evaluated for this customer service metric rating.
This field specifies the transaction lookback period used for the evaluation.
The start date and time of the transaction lookback range. All timestamps are based on Mountain Standard Time (MST).
The eBay marketplace ID of the marketplace upon which the customer service metric evaluation is based.
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.
|404||Resource not found. Invalid path parameters.|
|500||Internal Server Error|
For more on errors, plus the codes of other common errors, see Handling errors.
|54000||API_ANALYTICS||APPLICATION||There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.|
|54200||API_ANALYTICS||BUSINESS||The specified customer service metric is not available for the provided evaluation type and marketplace. Possible error causes are (1) Customer Service Metric values are not returned if the Seller does not have a valid transaction on the specified marketplace during the past 12 months or (2) sellers can retrieve CURRENT values only after they have been active on the specified marketplace for a complete benchmarking period.|
|54400||API_ANALYTICS||REQUEST||The specified customer service metric type is not a valid type. Valid metric types are ITEM_NOT_AS_DESCRIBED or ITEM_NOT_RECEIVED.|
|54401||API_ANALYTICS||REQUEST||The specified marketplace ID is not a supported marketplace. For a complete list of the supported marketplace IDs, see the documentation.|
|54402||API_ANALYTICS||REQUEST||The specified evaluation type is not a valid type. Valid evaluation types are CURRENT or PROJECTED.|
This call has no warnings.
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.
This example shows the CURRENT customer service metrics for Item not as described transactions.
For details on using and understanding the response from getCustomerServiceMetric, see Interpreting customer service metric ratings.
This method does not use a request payload, but configures an INAD request with the following URI parameters:
When successful, the call returns a response similar to this example sample shown.
Because the request sets the customer_service_metric_type URI parameter to
ITEM_NOT_AS_DESCRIBED, the dimension elements in the response have metricKey set to
The example below shows the different types of dimension elements you can expect to receive in an INAD set of metrics.
This example shows the PROJECTED customer service metrics for Item not received transactions.
There is no request payload for this call. Instead, this example configures the INR request using these URI parameters:
When successful, the call returns a response payload similar to the sample shown.
Because customer_service_metric_type is set to
ITEM_NOT_RECEIVED, the dimension elements in the response have metricKey set to
The response returns metrics for the three shipping corridors.