getCustomerServiceMetricTask: eBay Feed API

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

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

This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com

URI parameters

Parameter	Type	Description
task_id	string	This path parameter is the unique identifier of the customer service metric task being retrieved. Use the getCustomerServiceMetricTasks method to retrieve task IDs. Occurrence: Required

HTTP request headers

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

All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.

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.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

This call has no response headers.

Response payload

Copy complete valid JSON to clipboard

{ /* ServiceMetricsTask */

"completionDate" : "string",

"creationDate" : "string",

"detailHref" : "string",

"feedType" : "string",

"filterCriteria" :

{ /* CustomerServiceMetricsFilterCriteria */

"customerServiceMetricType" : "CustomerServiceMetricTypeEnum : [ITEM_NOT_AS_DESCRIBED,ITEM_NOT_RECEIVED]",

"evaluationMarketplaceId" : "MarketplaceIdEnum : [EBAY_AT,EBAY_AU,EBAY_BE...]",

"listingCategories" : [

"string"

"shippingRegions" : [

"ShippingRegionTypeEnum : [DOMESTIC,INTERNATIONAL_MATURED_REGION,INTERNATIONAL_EMERGING_REGION]"

]

"schemaVersion" : "string",

"status" : "FeedStatusEnum : [CREATED,QUEUED,IN_PROCESS...]",

"taskId" : "string"

}

Response fields

Output container/field	Type	Description
completionDate	string	The 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
creationDate	string	The date the customer service metrics task was created. Occurrence: Always
detailHref	string	The relative getCustomerServiceMetricTask call URI path to retrieve the corresponding task. Occurrence: Always
feedType	string	The feed type associated with the task. Occurrence: Always
filterCriteria	CustomerServiceMetricsFilterCriteria	This container shows the criteria set for the report. Occurrence: Always
filterCriteria.customerServiceMetricType	CustomerServiceMetricTypeEnum	An enumeration value that specifies the customer service metric that eBay tracks to measure seller performance. See CustomerServiceMetricTypeEnum for values. Occurrence: Always
filterCriteria.evaluationMarketplaceId	MarketplaceIdEnum	An enumeration value that specifies the eBay marketplace where the evaluation occurs. See MarketplaceIdEnum for values. Occurrence: Always
filterCriteria.listingCategories	array of string	A 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.shippingRegions	array of ShippingRegionTypeEnum	A 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
schemaVersion	string	The schema version number of the file format. If omitted, the default value is used. Default value: `1.0` Occurrence: Always
status	FeedStatusEnum	An enumeration value that indicates the state of the task. See FeedStatusEnum for values. Occurrence: Always
taskId	string	The 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.

Status	Meaning
200	Success
403	Forbidden
404	Not Found
500	Internal Server Error

Error codes

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

Code	Domain	Category	Meaning
160001	API_FEED	APPLICATION	There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
160002	API_FEED	REQUEST	The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.
160003	API_FEED	REQUEST	Task {taskID} does not exist.

Warnings

This call has no 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

This example illustrates how to retrieve customer service metric task details for a specified task.

Input

This method does not use a request payload, but requests details for a specific task by specifying the task_id created by a createCustomerServiceMetricTask call.

GEThttps://api.ebay.com/sell/feed/v1/customer_service_metric_task/task-*0-1********3

Output

When successful, the call returns a response similar to this example sample shown.