eBay · Schema

Metric

This complex data type defines the details of the customer service metric and benchmark data related to the associated dimension.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
benchmark object 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 ratin
distributions array 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
metricKey string This field indicates the customer service metric being returned in the associated metrics container. The field is set as follows:
  • TRANSACTION_COUNT – When set to this
value string 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
View JSON Schema on GitHub

JSON Schema

ebay-metric-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Metric",
  "title": "Metric",
  "type": "object",
  "properties": {
    "benchmark": {
      "description": "This complex type defines a set of benchmark data, which includes the <b>average</b> rating for the group included in the benchmark evaluation and the seller's calculated customer service metric rating for the benchmark.  <br><br>This container is returned only if the associated <b>metricKey</b> value is <code>RATE</code>.",
      "$ref": "#/components/schemas/MetricBenchmark"
    },
    "distributions": {
      "type": "array",
      "description": "Returned when <b>metricKey</b> equals <code>COUNT</code>, this field returns an array of  seller data where each set of data is grouped according by an overarching <b>basis</b>.  <br><br>When the seller distribution is returned, the numeric value of the associated <b>value</b> container equals the sum of the transactions where the seller meets the criteria of the customer service metric type for the given <b>dimension</b> during the <b>evaluationCycle</b>.",
      "items": {
        "$ref": "#/components/schemas/MetricDistribution"
      }
    },
    "metricKey": {
      "type": "string",
      "description": "This field indicates the customer service metric being returned in the associated <b>metrics</b> container. The field is set as follows: <ul><li><code>TRANSACTION_COUNT</code> &ndash; When set to this value, the associated <b>value</b> field returns the number of transactions completed in the peer group for the metric being evaluated in the associated <b>dimension</b> and <b>evaluationCycle</b>.</li> <li><code>COUNT</code> &ndash; When set to this value, the associated <b>value</b> field is set to the number of transactions completed by the seller for the metric being evaluated in the associated <b>dimension</b> and <b>evaluationCycle</b>.</li> <li><code>RATE</code> &ndash; When set to this value, the fields in the associated container return the seller's calculated <b>value</b> for the associated customer service metric along with the benchmark data against which the seller is evaluated.  <br><br>Specifically, when <b>metricKey</b> is set to <code>RATE</code>, the associated <b>value</b> field is set to the value of <b>metricKey</b> <code>TRANSACTION_COUNT</code> divided by the value of <b>metricKey</b> <code>COUNT</code>.  <br><br>The <b>benchmark.rating</b> value is the seller's rating for the metric in the associated <b>dimension</b> and <b>evaluationCycle</b>.</li></ul>"
    },
    "value": {
      "type": "string",
      "description": "This field is set to the seller's numeric rating for the associated <b>metricKey</b> for the given <b>dimension</b> during the <b>evaluationCycle</b>.  <br><br>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 <b>dimension</b>."
}