GET/customer_service_metric_task
Use this method to return an array of customer service metric tasks. You can limit the tasks returned by specifying a date range.
Note: You can pass in either the look_back_days or date_range, but not both.
Input
Resource URI
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 |
|---|---|---|
| feed_type | string | The feed type associated with the tasks being retrieved. The only presently supported value is CUSTOMER_SERVICE_METRICS_REPORT. Occurrence: Required |
| look_back_days | integer | The number of previous days in which to search for tasks. Do not use with the date_range parameter. If both date_range and look_back_days are omitted, this parameter's default value is used. Default value: 7 Range: 1-90 (inclusive) Occurrence: Optional |
| date_range | string | The task creation date range. The results are filtered to include only tasks with a creation date that is equal to the dates specified or is within the specified range. Do not use with the look_back_days parameter.Format: UTC For example, tasks within a range:
Tasks created on March 8, 2020
Maximum: 90 days Occurrence: Optional |
| limit | integer | The number of customer service metric tasks to return per page of the result set. Use this parameter in conjunction with the offset parameter to control the pagination of the output. For example, if offset is set to 10 and limit is set to 10, the call retrieves tasks 11 thru 20 from the result set. If this parameter is omitted, the default value is used. Note:This feature employs a zero-based list, where the first item in the list has an offset of Default: 10 Maximum: 500 Occurrence: Optional |
| offset | integer | The number of customer service metric tasks to skip in the result set before returning the first task in the paginated response. Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of Occurrence: Optional |
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
Response fields
| Output container/field | Type | Description |
|---|---|---|
| href | string | The URI of the current page of results. Occurrence: Always |
| limit | integer | The value of the limit parameter submitted in the request, which is the maximum number of tasks to return per page, from the result set. A result set is the complete set of tasks returned by the method. Note: Even though this parameter is not required to be submitted in the request, the parameter defaults to 10 if omitted. Note: If this is the last or only page of the result set, the page may contain fewer tasks than the limit value. To determine the number of pages in a result set, divide the total value (total number of tasks matching input criteria) by this limit value, and then round up to the next integer. For example, if the total value was Occurrence: Always |
| next | string | The relative path to the call URI for the next page of results. This value is returned if there is an additional page of results to return from the result set. Occurrence: Conditional |
| offset | integer | The number of results skipped in the result set before returning the first result. This value can be set in the request with the offset query parameter. Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of Occurrence: Always |
| prev | string | The URI for the previous page of results. This parameter is returned if a previous page of results from the result set exists. Occurrence: Conditional |
| tasks | array of ServiceMetricsTask | An array of the customer service tasks on this page. The tasks are sorted by creation date. An empty array is returned if the filter criteria excludes all tasks. Occurrence: Always |
| tasks.completionDate | string | The timestamp when the customer service metrics task went into the Occurrence: Conditional |
| tasks.creationDate | string | The date the customer service metrics task was created. Occurrence: Always |
| tasks.detailHref | string | The relative getCustomerServiceMetricTask call URI path to retrieve the corresponding task. Occurrence: Always |
| tasks.feedType | string | The feed type associated with the task. Occurrence: Always |
| tasks.filterCriteria | CustomerServiceMetricsFilterCriteria | This container shows the criteria set for the report. Occurrence: Always |
| tasks.filterCriteria.customerServiceMetricType | CustomerServiceMetricTypeEnum | An enumeration value that specifies the customer service metric that eBay tracks to measure seller performance. Occurrence: Always |
| tasks.filterCriteria.evaluationMarketplaceId | MarketplaceIdEnum | An enumeration value that specifies the eBay marketplace where the evaluation occurs. Occurrence: Always |
| tasks.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 Supported categories include:
Occurrence: Conditional |
| tasks.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 Supported categories include:
Occurrence: Conditional |
| tasks.schemaVersion | string | The schema version number of the file format. If omitted, the default value is used. Default value:
Occurrence: Always |
| tasks.status | FeedStatusEnum | An enumeration value that indicates the state of the task. See FeedStatusEnum for values. Occurrence: Always |
| tasks.taskId | string | The unique eBay-assigned ID of the task. Occurrence: Always |
| total | integer | The total number of tasks that match the criteria. 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 |
| 400 | Bad Request |
| 403 | Forbidden |
| 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. |
| 160005 | API_FEED | REQUEST | Both 'feed_type' and 'schedule_id' were provided. Please remove one of them. |
| 160006 | API_FEED | REQUEST | The 'feed_type' {feedTypeValue} is invalid. |
| 160008 | API_FEED | REQUEST | Both 'look_back_days' and 'date_range' were provided. Please remove one of them. |
| 160009 | API_FEED | REQUEST | The format of the 'date_range' is invalid. The format for a date range is yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ. |
| 160010 | API_FEED | REQUEST | The 'date_range' must be less than or equal to 90 days. |
| 160011 | API_FEED | REQUEST | The 'look_back_days' value must be greater than zero and less than or equal to 90. |
| 160012 | API_FEED | REQUEST | The 'limit' value must be greater than zero and less than or equal to 500. |
| 160013 | API_FEED | REQUEST | The 'offset' value cannot be less than zero. |
| 160029 | API_FEED | REQUEST | The 'offset' value must be a multiple of the 'limit' value. |
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: Retrieve Customer Service Metric Tasks
This call retrieves an array of customer service metric tasks based on the specified criteria.
Input
The input is the feed_type.
GEThttps://api.ebay.com/sell/feed/v1/customer_service_metric_task?feed_type=CUSTOMER_SERVICE_METRICS_REPORT
Output
If the call is successful, the output is an array of tasks and the details for each task, such as the taskId, status, feedType, filterCriteria, and other details.