Returns a seller's performance and rating for the customer service metric by the established shipping corridors.
The driver will use the eBay Analytics API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the driver.
To query the CustomerServiceMetricByShippingRegion view, a value for the EvaluationType and MarketplaceId columns should be specified.
- In case, the MarketplaceId is not specified, the value set in the MarketplaceId connection property will be used instead by default.
The MarketplaceId is server side filterable and supports only the operator: =.
Supported MarketplaceId values are: EBAY_AU, EBAY_CA, EBAY_FR, EBAY_DE, EBAY_GB, EBAY_IT, EBAY_ES and EBAY_US.
- In case, the EvaluationType is not specified, the eBay Analytics will generate a report based on the data for the CURRENT period.
The EvaluationType is server side filterable and supports only the operator: =.
Supported EvaluationType values are: CURRENT and PROJECTED.
The example query below will return CustomerServiceMetricByShippingRegion data for the CURRENT Evaluation Type period and for the Marketplace specified in the MarketplaceId connection property.
SELECT * FROM CustomerServiceMetricByShippingRegion
The example query below will return CustomerServiceMetricByShippingRegion data for the PROJECTED Evaluation Type period and for the German Marketplace.
SELECT * FROM CustomerServiceMetricByShippingRegion WHERE EvaluationType = 'PROJECTED' AND MarketplaceId = 'EBAY_DE'
Note: Querying this view will return results only if the below conditions are met.
- The seller has a valid transaction on the specified marketplace (MarketplaceId) during the past 12 months.
- If the 'CURRENT' EvaluationType is specified, the seller must have been active on the specified marketplace (MarketplaceId) for a complete benchmarking period (eBay evaluation period, usually one month).
|ShippingRegionId||String||The Id of the established shipping corridor.|
|ShippingRegionName||String||The Name of the established shipping corridor.|
|TransactionCount||Integer||The total number of transactions completed in the seller group for the MetricType in the given dimension during the associated evaluationCycle.|
|Count||Integer||The total number of transactions the seller completed that meet the criteria of the MetricType for the given dimension that occurred during the evaluationCycle.|
|DistributionsBasis||String||The overarching basis by which an array of seller data is grouped. Along with DistributionsData, they expand the total number of transactions in Count column grouped by a certain basis.|
|DistributionsData||String||Expands the Count column data via an aggregated 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.|
|Rate||Double||The rate of the customer service MetricType in the given dimension during the associated evaluationCycle. Specifically, it is the TransactionCount divided by the Count value.|
|BenchmarkBasis||String||The basis by which the benchmark is calculated for the MetricType.|
|BenchmarkRating||String||The seller's rating for the ServiceMetric. It represents the relative deviation between the seller's Rate metric value and the benchmark value for the specified ServiceMetric.|
|BenchmarkAverage||Double||The average value for the group, as defined by the specified BenchmarkBasis. When BenchmarkBasis is 'PEER_BENCHMARK', this is the benchmark value to which the seller's metric value is compared to determine the BenchmarkRating for the ServiceMetric.|
|BenchmarkAdjustment||String||The reason why the rating given to the seller was adjusted.|
|EvaluationDate||Datetime||Date and time at which the seller was evaluated for this customer service metric rating.|
|EvaluationType||String||This field specifies the transaction lookback period used for the evaluation. Supported values are: CURRENT, PROJECTED.|
|StartDate||Datetime||The start date and time of the transaction lookback range.|
|EndDate||Datetime||End date and time of the transaction lookback range.|
|MarketplaceId||String||The eBay marketplace ID of the marketplace upon which the customer service metric evaluation is based.|
|MetricType||String||The type of customer service metric.|