feed APIv1.1.0

getCustomerServiceMetricTask

GET
/customer_service_metric_task/{task_id}

Use this method to retrieve customer service metric task details for the specified task. The input is task_id.

Input

Resource URI (production)

GET https://api.ebay.com/sell/feed/v1/customer_service_metric_task/{task_id}

URI parameters

ParameterTypeDescription
task_idstringUse this path parameter to specify the task ID value for the customer service metric task to retrieve.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

OAuth scope

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):

https://api.ebay.com/oauth/api_scope/sell.analytics.readonly

See OAuth access tokens for more information.

Output

HTTP response headers

Output container/fieldTypeDescription
completionDatestringThe timestamp when the customer service metrics task went into the COMPLETED or COMPLETED_WITH_ERROR state. This field is only returned if the status is one of the two completed values. This state means that eBay has compiled the report for the seller based on the seller’s filter criteria, and the seller can run a getResultFile call to download the report.

Occurrence: Conditional

creationDatestringThe date the customer service metrics task was created.

Occurrence: Always

detailHrefstringThe relative getCustomerServiceMetricTask call URI path to retrieve the corresponding task.

Occurrence: Always

feedTypestringThe feed type associated with the task.

Occurrence: Always

filterCriteriaCustomerServiceMetricsFilterCriteriaThis container shows the criteria set for the report.

Occurrence: Always

filterCriteria.customerServiceMetricTypeCustomerServiceMetricTypeEnumAn enumeration value that specifies the customer service metric that eBay tracks to measure seller performance. See CustomerServiceMetricTypeEnum for values.

Occurrence: Always

filterCriteria.evaluationMarketplaceIdMarketplaceIdEnumAn enumeration value that specifies the eBay marketplace where the evaluation occurs. See MarketplaceIdEnum for values.

Occurrence: Always

filterCriteria.listingCategoriesarray of stringA list of listing category IDs on which the service metric is measured. A seller can use one or more L1 (top-level) eBay categories to get metrics specific to those L1 categories. The Category IDs for each L1 category are required. Category ID values for L1 categories can be retrieved using the Taxonomy API.

Note: Pass this attribute to narrow down your filter results for the ITEM_NOT_AS_DESCRIBED customerServiceMetricType.

Supported categories include:

primary(L1) category Id

Occurrence: Conditional

filterCriteria.shippingRegionsarray of ShippingRegionTypeEnumA list of shipping region enumeration values on which the service metric is measured. This comma delimited array allows the seller to customize the report to focus on domestic or international shipping.

Note: Pass this attribute to narrow down your filter results for the ITEM_NOT_RECEIVED customerServiceMetricType.

Supported categories include:

primary(L1) category Id

See ShippingRegionTypeEnum for values

Occurrence: Conditional

schemaVersionstringThe schema version number of the file format. If omitted, the default value is used.

Default value: 1.0

Occurrence: Always

statusFeedStatusEnumAn enumeration value that indicates the state of the task. See FeedStatusEnum for values.

Occurrence: Always

taskIdstringThe unique eBay-assigned ID of the task.

Occurrence: Always

HTTP status codes

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.

StatusMeaning
200Success
403Forbidden
404Not Found
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
160001API_FEEDAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
160002API_FEEDREQUESTThe authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.
160003API_FEEDREQUESTTask {taskID} does not exist.

Warnings

Samples

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.

Sample 1: Customer service metric: Item Not As Described

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.

Input

This method does not use a request payload, but configures an SNAD request with the following URI parameters:
  • Set customer_service_metric_type to ITEM_NOT_AS_DESCRIBED.
  • Set evaluation_type to CURRENT.
  • Set evaluation_marketplace_id to EBAY_GB.
GET
https://api.ebay.com/sell/analytics/v1/customer_service_metric/ITEM_NOT_AS_DESCRIBED/CURRENT?evaluation_marketplace_id=EBAY_GB

Output

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 LISTING_CATEGORY.

The example below shows the different types of dimension elements you can expect to receive in an INAD set of metrics.

Sample 2: Customer service metric: Item Not Received

This example shows the PROJECTED customer service metrics for Item not received transactions.

Input

This method does not use a request payload, but configures an INR request using these URI parameters:
  • Set customer_service_metric_type to ITEM_NOT_RECEIVED.
  • Set evaluation_type to PROJECTED.
  • Set evaluation_marketplace_id to EBAY_GB.
GET
https://api.ebay.com/sell/feed/v1/customer_service_metric/ITEM_NOT_RECEIVED/PROJECTED?evaluation_marketplace_id=EBAY_US

Output

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 SHIPPING_REGION.

The response returns metrics for the three shipping corridors.