openapi: 3.0.0 info: title: eBay Account Advertising_eligibility Customer_service_metric API description: The Account API gives sellers the ability to configure their eBay seller accounts, including the seller's policies (eBay business policies and seller-defined custom policies), opt in and out of eBay seller programs, configure sales tax tables, and get account information.

For details on the availability of the methods in this API, see Account API requirements and restrictions. contact: name: eBay Inc, license: name: eBay API License Agreement url: https://go.developer.ebay.com/api-license-agreement version: v1.9.2 servers: - url: https://api.ebay.com{basePath} description: Production variables: basePath: default: /sell/account/v1 tags: - name: Customer_service_metric paths: /customer_service_metric/{customer_service_metric_type}/{evaluation_type}: get: tags: - Customer_service_metric description: '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: Currently, metric data is returned for only peer benchmarking. For details on the workings of peer benchmarking, see Service metrics policy.

For details on using and understanding the response from this method, see Interpreting customer service metric ratings.' operationId: getCustomerServiceMetric parameters: - name: customer_service_metric_type in: path description: Use this path parameter to specify the type of customer service metrics and benchmark data you want returned for the seller. Supported types are:
required: true schema: type: string - name: evaluation_marketplace_id in: query description: 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. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/analytics/types/bas:MarketplaceIdEnum required: true schema: type: string - name: evaluation_type in: path description: Use this path parameter to specify the evaluation period to use for the performance metrics. See EvaluationTypeEnum for more information on the supported values. required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetCustomerServiceMetricResponse' '400': description: Bad Request x-response-codes: errors: '54401': domain: API_ANALYTICS category: REQUEST description: The specified marketplace ID is not a supported marketplace. For a complete list of the supported marketplace IDs, see the documentation. '404': description: 'Resource not found. Invalid path parameters. ' x-response-codes: errors: '54400': domain: API_ANALYTICS category: REQUEST description: The specified customer service metric type is not a valid type. Valid metric types are ITEM_NOT_AS_DESCRIBED or ITEM_NOT_RECEIVED. '54402': domain: API_ANALYTICS category: REQUEST description: The specified evaluation type is not a valid type. Valid evaluation types are CURRENT or PROJECTED. '409': description: Conflict x-response-codes: errors: '54200': domain: API_ANALYTICS category: BUSINESS description: 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. '500': description: Internal Server Error x-response-codes: errors: '54000': domain: API_ANALYTICS category: APPLICATION description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. security: - api_auth: - https://api.ebay.com/oauth/api_scope/sell.analytics.readonly components: schemas: BenchmarkMetadata: type: object properties: average: type: string description: This field returns the average value for the group, as defined by the specified basis.

When the benchmark basis is set to PEER_BENCHMARK, the value returned in this field is the benchmark value to which the seller's metric value is compared to determine the seller's rating for the customer service metric. description: This complex type defines the fields that comprise the benchmark against which the seller's performance is compared. The comparison determines the seller's rating for the metric. Metric: type: object properties: benchmark: description: 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.

This container is returned only if the associated metricKey value is RATE. $ref: '#/components/schemas/MetricBenchmark' distributions: type: array description: Returned when metricKey equals COUNT, this field returns an array of seller data where each set of data is grouped according by an overarching basis.

When the seller distribution is returned, the numeric value of the associated value container equals the sum of the transactions where the seller meets the criteria of the customer service metric type for the given dimension during the evaluationCycle. items: $ref: '#/components/schemas/MetricDistribution' metricKey: type: string description: 'This field indicates the customer service metric being returned in the associated metrics container. The field is set as follows: ' value: type: string description: This field is set to the seller's numeric rating for the associated metricKey for the given dimension during the evaluationCycle.

To determine the seller's rating for this metric, the value of this field is compared to the average metric value of the group. description: This complex data type defines the details of the customer service metric and benchmark data related to the associated dimension. Dimension: type: object properties: dimensionKey: type: string description: 'dimensionKey defines the basis against which the seller''s customer service metric is measured.

The value of this field gets set according to the value of the customer_service_metric_type input parameter. The following input configurations return the responses shown: For implementation help, refer to eBay API documentation' name: type: string description: 'The dimension name returned in this field depends on the dimensionKey: ' value: type: string description: 'The value returned in this field depends on the dimensionKey.

If dimensionKey equals LISTING_CATEGORY, the value returned in this field is the category ID of the primary (L1) category in which the items being rated were listed.

If dimensionKey equals SHIPPING_REGION, one of the following values is returned: ' description: The fields in this complex type define the dimension, or attributes, by which the associated customer service metric and benchmark data is measured.

The value of dimensionKey gets set according to the configuration of the input request. The name and value pair further define dimension under the key. MetricBenchmark: type: object properties: adjustment: type: string description: If this field is present, it indicates that the rating given to the seller was "adjusted" for one reason or another.

If eBay determines that the normal rating of a seller is impacted by circumstances beyond their control, they can issue an override to adjust the rating given to the seller. For implementation help, refer to eBay API documentation basis: type: string description: This field returns the "basis" by which the benchmark is calculated for the customer service metric type.

Currently, the only supported basis is PEER_BENCHMARK. For implementation help, refer to eBay API documentation metadata: description: This field contains the benchmark data. $ref: '#/components/schemas/BenchmarkMetadata' rating: type: string description: This field returns seller's rating for the customer service metric.

The rating is set to a value that equals the relative deviation between the seller's metric value and the benchmark value for the customer service metric.

Deviation values range from LOW to VERY HIGH, and the lower the deviation, the better the seller rating. For implementation help, refer to eBay API documentation description: This complex type defines the benchmark data, which includes the average value of the metric for the group (the benchmark) and the seller's overall rating when compared to the benchmark. GetCustomerServiceMetricResponse: type: object properties: dimensionMetrics: type: array description: 'This container provides a seller''s customer service metric performance for a given dimension.

In the getCustomerServiceMetric request, specify values for the following request parameters to control the returned dimension and the associated metric values: ' items: $ref: '#/components/schemas/DimensionMetric' evaluationCycle: description: This complex type defines the evaluation type (CURRENT or PROJECTED) and the transaction lookback period used to calculate the seller's customer service metric. $ref: '#/components/schemas/EvaluationCycle' marketplaceId: type: string description: The eBay marketplace ID of the marketplace upon which the customer service metric evaluation is based.

The customer_service_metric resource supports a limited set of marketplaces. For a complete list of the supported marketplaces, please see the Service metrics policy page. For implementation help, refer to eBay API documentation description: This complex data type defines the response data that is returned from a request to getCustomerServiceMetric.

The dimensionMetrics object contains the details of the dimension being measured and the calculated customer service metric values.

The evaluationCycle defines the period used to calculate the metric values.

The marketplaceId is the eBay marketplace for which the metrics are being considered. DimensionMetric: type: object properties: dimension: description: This type defines the "dimension," or attributes, against which the associated customer service metric values and benchmark ratings are based.

The dimensionKey value is set according to the customer_service_metric_type request parameter and the values in the associated name/value pairs relate to the dimensionKey that's being used to calculate the benchmark rating. $ref: '#/components/schemas/Dimension' metrics: type: array description: This is a list of Metric elements where each element contains data and information related to the transactions grouped by the associated dimension. items: $ref: '#/components/schemas/Metric' description: This complex type defines a the customer service metrics and seller benchmark performance related to a given dimension. EvaluationCycle: type: object properties: endDate: type: string description: End date and time of the transaction lookback range. All timestamps are based on Mountain Standard Time (MST).

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. evaluationDate: type: string description: The ISO-8601 date and time at which the seller was evaluated for this customer service metric rating. evaluationType: type: string description: 'This field specifies the transaction lookback period used for the evaluation.

The evaluation_type value specified in the request is returned in this field. There are two possible values: For implementation help, refer to eBay API documentation' startDate: type: string description: The start date and time of the transaction lookback range. All timestamps are based on Mountain Standard Time (MST).

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2018-08-04T07:09:00.000Z description: This complex type describes the start and end dates of the of the time period over which the associated benchmark is computed.

All timestamps are based on Mountain Standard Time (MST).

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Distribution: type: object properties: name: type: string description: The name of a distribution in which the seller is active. value: type: string description: This field contains the number of transactions the seller had in the distribution (identified by the associated name field) during the metric evaluationCycle. description: This complex type defines of a piece of data that is grouped by the associated basis. It contains the name for the data set and its associated value. MetricDistribution: type: object properties: basis: type: string description: This field returns the basis, or the method, by which the metric rating is calculated. data: type: array description: 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. items: $ref: '#/components/schemas/Distribution' description: This complex data type describes the metric distribution by basis. securitySchemes: api_auth: type: oauth2 description: The security definitions for this API. Please check individual operations for applicable scopes. flows: authorizationCode: authorizationUrl: https://auth.ebay.com/oauth2/authorize tokenUrl: https://api.ebay.com/identity/v1/oauth2/token scopes: https://api.ebay.com/oauth/api_scope/sell.account.readonly: View your account settings https://api.ebay.com/oauth/api_scope/sell.account: View and manage your account settings