{
"opencollection": "1.0.0",
"info": {
"name": "eBay Account Advertising_eligibility Customer_service_metric_task API",
"version": "v1.9.2"
},
"items": [
{
"info": {
"name": "Customer_service_metric_task",
"type": "folder"
},
"items": [
{
"info": {
"name": "getCustomerServiceMetricTasks",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.ebay.com{basePath}/customer_service_metric_task",
"params": [
{
"name": "date_range",
"value": "",
"type": "query",
"description": "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:
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
" }, { "name": "feed_type", "value": "", "type": "query", "description": "The feed type associated with the tasks being retrieved. The only presently supported value isCUSTOMER_SERVICE_METRICS_REPORT."
},
{
"name": "limit",
"value": "",
"type": "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
" }, { "name": "look_back_days", "value": "", "type": "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)
" }, { "name": "offset", "value": "", "type": "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"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
"accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "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.
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 an"
},
{
"info": {
"name": "getCustomerServiceMetricTask",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.ebay.com{basePath}/customer_service_metric_task/:task_id",
"params": [
{
"name": "task_id",
"value": "",
"type": "path",
"description": "This path parameter is the unique identifier of the customer service metric task being retrieved.
Use the getCustomerServiceMetricTasks method to retrieve task IDs."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
"accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "
Use this method to retrieve customer service metric task details for the specified task. The input is task_id.
" } ] } ], "bundled": true }