eBay · Schema

GetCustomerServiceMetricResponse

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.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
dimensionMetrics array This container provides a seller's customer service metric performance for a given dimension.

In the getCustomerServiceMetric request, specify values for the following req
evaluationCycle object This complex type defines the evaluation type (CURRENT or PROJECTED) and the transaction lookback period used to calculate the seller's customer service metric.
marketplaceId string 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
View JSON Schema on GitHub

JSON Schema

ebay-getcustomerservicemetricresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetCustomerServiceMetricResponse",
  "title": "GetCustomerServiceMetricResponse",
  "type": "object",
  "properties": {
    "dimensionMetrics": {
      "type": "array",
      "description": "This container provides a seller's customer service <b>metric</b> performance for a given <b>dimension</b>.  <br><br>In the <b>getCustomerServiceMetric</b> request, specify values for the following request parameters to control the returned dimension and the associated metric values: <ul><li> <b>customer_service_metric_type</b></li> <li><b>evaluation_type</b></li> <li><b>evaluation_marketplace_id</b></li></ul>",
      "items": {
        "$ref": "#/components/schemas/DimensionMetric"
      }
    },
    "evaluationCycle": {
      "description": "This complex type defines the evaluation type (<code>CURRENT</code> or <code>PROJECTED</code>) 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.  <br><br>The <b>customer_service_metric</b> resource supports a limited set of marketplaces. For a complete list of the supported marketplaces, please see the <a href=\"https://www.ebay.com/help/policies/selling-policies/seller-performance-policy/service-metrics-policy?id=4769#section2\" title=\"eBay Help pages\">Service metrics policy</a> page. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/analytics/types/bas:MarketplaceIdEnum'>eBay API documentation</a>"
    }
  },
  "description": "This complex data type defines the response data that is returned from a request to <b>getCustomerServiceMetric</b>.  <br><br>The <b>dimensionMetrics</b> object contains the details of the dimension being measured and the calculated customer service metric values. <br><br>The <b>evaluationCycle</b> defines the period used to calculate the metric values.  <br><br>The <b>marketplaceId</b> is the eBay marketplace for which the metrics are being considered."
}