Note: You can pass in either the look_back_days or date_range, but not both.
look_back_days parameter.Format: UTC
For example, tasks within a range:
yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ
Tasks created on March 8, 2020
2020-03-08T00:00.00.000Z..2020-03-09T00:00:00.000Z
Maximum: 90 days
' required: false schema: type: string - name: feed_type in: query description: The feed type associated with the tasks being retrieved. The only presently supported value isCUSTOMER_SERVICE_METRICS_REPORT.
required: false
schema:
type: string
- name: limit
in: query
description: 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 0.
Default: 10
Maximum: 500
required: false schema: type: string - name: look_back_days in: query description: The number of previous days in which to search for tasks. Do not use with thedate_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)
required: false schema: type: string - name: offset in: query description: '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 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set.
Default: 0'
required: false
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerServiceMetricTaskCollection'
'400':
description: Bad Request
x-response-codes:
errors:
'160002':
domain: API_FEED
category: REQUEST
description: The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.
'160005':
domain: API_FEED
category: REQUEST
description: Both 'feed_type' and 'schedule_id' were provided. Please remove one of them.
'160006':
domain: API_FEED
category: REQUEST
description: The 'feed_type' {feedTypeValue} is invalid.
'160008':
domain: API_FEED
category: REQUEST
description: Both 'look_back_days' and 'date_range' were provided. Please remove one of them.
'160009':
domain: API_FEED
category: REQUEST
description: 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':
domain: API_FEED
category: REQUEST
description: The 'date_range' must be less than or equal to 90 days.
'160011':
domain: API_FEED
category: REQUEST
description: The 'look_back_days' value must be greater than zero and less than or equal to 90.
'160012':
domain: API_FEED
category: REQUEST
description: The 'limit' value must be greater than zero and less than or equal to 500.
'160013':
domain: API_FEED
category: REQUEST
description: The 'offset' value cannot be less than zero.
'160029':
domain: API_FEED
category: REQUEST
description: The 'offset' value must be a multiple of the 'limit' value.
'403':
description: Forbidden
'500':
description: Internal Server Error
x-response-codes:
errors:
'160001':
domain: API_FEED
category: APPLICATION
description: There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.analytics.readonly
post:
tags:
- Customer_service_metric_task
description:
Use this method to create a customer service metrics download task with filter criteria for the customer service metrics report. When using this method, specify the feedType and filterCriteria including both evaluationMarketplaceId and customerServiceMetricType for the report. The method returns the location response header containing the call URI to use with getCustomerServiceMetricTask to retrieve status and details on the task.
Only CURRENT Customer Service Metrics reports can be generated with the Sell Feed API. PROJECTED reports are not supported at this time. See the getCustomerServiceMetric method document in the Analytics API for more information about these two types of reports.
Note: Before calling this API, retrieve the summary of the seller's performance and rating for the customer service metric by calling getCustomerServiceMetric (part of the Analytics API). You can then populate the create task request fields with the values from the response. This technique eliminates failed tasks that request a report for a customerServiceMetricType and evaluationMarketplaceId that are without evaluation.
operationId: createCustomerServiceMetricTask parameters: - name: Accept-Language in: header description: Use this header to specify the natural language in which the authenticated user desires the response. For example,en-US for English or de-DE for German.
required: true
schema:
type: string
- name: Content-Type
in: header
description: This header indicates the format of the request body provided by the client. Its value should be set to application/json. Use this method to retrieve customer service metric task details for the specified task. The input is task_id.
operationId: getCustomerServiceMetricTask parameters: - name: task_id in: path description: This path parameter is the unique identifier of the customer service metric task being retrieved.CUSTOMER_SERVICE_METRICS_REPORT
1.0.
description: The type that defines the fields for the Customer Service Metric reports generated with the Feed API.
ServiceMetricsTask:
type: object
properties:
completionDate:
type: string
description: 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.
creationDate:
type: string
description: The date the customer service metrics task was created.
detailHref:
type: string
description: The relative getCustomerServiceMetricTask call URI path to retrieve the corresponding task.
feedType:
type: string
description: The feed type associated with the task.
filterCriteria:
description: This container shows the criteria set for the report.
$ref: '#/components/schemas/CustomerServiceMetricsFilterCriteria'
schemaVersion:
type: string
description: 'The schema version number of the file format. If omitted, the default value is used. Default value: 1.0
'
status:
type: string
description: An enumeration value that indicates the state of the task. See FeedStatusEnum for values. For implementation help, refer to eBay API documentation
taskId:
type: string
description: The unique eBay-assigned ID of the task.
CustomerServiceMetricsFilterCriteria:
type: object
properties:
customerServiceMetricType:
type: string
description: An enumeration value that specifies the customer service metric that eBay tracks to measure seller performance.
See CustomerServiceMetricTypeEnum for values. For implementation help, refer to eBay API documentation
evaluationMarketplaceId:
type: string
description: An enumeration value that specifies the eBay marketplace where the evaluation occurs.
See MarketplaceIdEnum for values. For implementation help, refer to eBay API documentation
listingCategories:
type: array
description: '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
Note: Pass this attribute to narrow down your filter results for the ITEM_NOT_RECEIVED customerServiceMetricType.
Supported categories include:
primary(L1) category Id
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 120 (120 total tasks) and the limit value was 50 (show 50 tasks per page), the total number of pages in the result set is three, so the seller would have to make three separate getCustomerServiceMetricTasks calls to view all tasks matching the input criteria.
Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0.