openapi: 3.0.0
info:
title: ' Seller Service Metrics API '
description: 'The Analytics API provides data and information about a seller and their eBay business.
The resources and methods in this API let sellers review information on their listing performance, metrics on their customer service performance, and details on their eBay seller performance rating.
The three resources in the Analytics API provide the following data and information:
- Customer Service Metric – Returns benchmark data and a metric rating pertaining to a seller''s customer service performance as compared to other seller''s in the same peer group.
- Traffic Report – Returns data and information that shows how buyers are engaging with a seller''s listings.
- Seller Standards Profile – Returns information pertaining to a seller''s profile rating.
Sellers can use the data and information returned by the various Analytics API methods to determine where they can make improvements to increase sales and how they might improve their seller status as viewed by eBay buyers.
For details on using this API, see Analyzing seller performance.'
contact:
name: eBay Inc,
license:
name: eBay API License Agreement
url: https://go.developer.ebay.com/api-license-agreement
version: 1.3.2
servers:
- url: https://api.ebay.com{basePath}
description: Production
variables:
basePath:
default: /sell/analytics/v1
paths:
/customer_service_metric/{customer_service_metric_type}/{evaluation_type}:
get:
tags:
- customer_service_metric
description: 'Use this method to retrieve a seller''s performance and rating for the customer service metric.
Control the response from the getCustomerServiceMetric method using the following path and query parameters: - customer_service_metric_type controls the type of customer service transactions evaluated for the metric rating.
- evaluation_type controls the period you want to review.
- evaluation_marketplace_id specifies the target marketplace for the evaluation.
Currently, metric data is returned for only peer benchmarking. For details on the workings of peer benchmarking, see Service metrics policy.
For details on using and understanding the response from this method, see Interpreting customer service metric ratings.'
operationId: getCustomerServiceMetric
parameters:
- name: customer_service_metric_type
in: path
description: Use this path parameter to specify the type of customer service metrics and benchmark data you want returned for the seller. Supported types are:
ITEM_NOT_AS_DESCRIBED
ITEM_NOT_RECEIVED
required: true
schema:
type: string
- name: evaluation_marketplace_id
in: query
description: Use this query parameter to specify the Marketplace ID to evaluate for the customer service metrics and benchmark data.
For the list of supported marketplaces, see Analytics API requirements and restrictions. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/analytics/types/bas:MarketplaceIdEnum
required: true
schema:
type: string
- name: evaluation_type
in: path
description: Use this path parameter to specify the evaluation period to use for the performance metrics. See EvaluationTypeEnum for more information on the supported values.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetCustomerServiceMetricResponse'
'400':
description: Bad Request
x-response-codes:
errors:
'54401':
domain: API_ANALYTICS
category: REQUEST
description: The specified marketplace ID is not a supported marketplace. For a complete list of the supported marketplace IDs, see the documentation.
'404':
description: 'Resource not found. Invalid path parameters. '
x-response-codes:
errors:
'54400':
domain: API_ANALYTICS
category: REQUEST
description: The specified customer service metric type is not a valid type. Valid metric types are ITEM_NOT_AS_DESCRIBED or ITEM_NOT_RECEIVED.
'54402':
domain: API_ANALYTICS
category: REQUEST
description: The specified evaluation type is not a valid type. Valid evaluation types are CURRENT or PROJECTED.
'409':
description: Conflict
x-response-codes:
errors:
'54200':
domain: API_ANALYTICS
category: BUSINESS
description: The specified customer service metric is not available for the provided evaluation type and marketplace. Possible error causes are (1) Customer Service Metric values are not returned if the Seller does not have a valid transaction on the specified marketplace during the past 12 months or (2) sellers can retrieve CURRENT values only after they have been active on the specified marketplace for a complete benchmarking period.
'500':
description: Internal Server Error
x-response-codes:
errors:
'54000':
domain: API_ANALYTICS
category: APPLICATION
description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.analytics.readonly
/seller_standards_profile:
get:
tags:
- seller_standards_profile
description: This call retrieves all the standards profiles for the associated seller.
A standards profile is a set of eBay seller metrics and the seller's associated compliance values (either TOP_RATED
, ABOVE_STANDARD
, or BELOW_STANDARD
).
A seller's multiple profiles are distinguished by two criteria, a "program" and a "cycle." A profile's program is one of three regions where the seller may have done business, or PROGRAM_GLOBAL
to indicate all marketplaces where the seller has done business. The cycle value specifies whether the standards compliance values were determined at the last official eBay evaluation or at the time of the request.
operationId: findSellerStandardsProfiles
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/FindSellerStandardsProfilesResponse'
'400':
description: Bad Request
'500':
description: Internal Server Error
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.analytics.readonly
/seller_standards_profile/{program}/{cycle}:
get:
tags:
- seller_standards_profile
description: This call retrieves a single standards profile for the associated seller.
A standards profile is a set of eBay seller metrics and the seller's associated compliance values (either TOP_RATED
, ABOVE_STANDARD
, or BELOW_STANDARD
).
A seller can have multiple profiles distinguished by two criteria, a "program" and a "cycle." A profile's program is one of three regions where the seller may have done business, or PROGRAM_GLOBAL
to indicate all marketplaces where the seller has done business. The cycle value specifies whether the standards compliance values were determined at the last official eBay evaluation (CURRENT
) or at the time of the request (PROJECTED
). Both cycle and a program values are required URI parameters for this method.
operationId: getSellerStandardsProfile
parameters:
- name: cycle
in: path
description: This path parameter is used to specify the cycle for which metrics and metadata will be retrieved.
See CycleTypeEnum for a list of supported values.
required: true
schema:
type: string
- name: program
in: path
description: This path parameter is used to specify the seller standards program for which metrics and metadata will be retrieved.
See ProgramEnum for a list of supported values.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StandardsProfile'
'204':
description: No content
'400':
description: Bad Request
x-response-codes:
errors:
'53100':
domain: API_ANALYTICS
category: REQUEST
description: Program Id cannot be empty.
'53105':
domain: API_ANALYTICS
category: REQUEST
description: Invalid program Id {programId}
'53110':
domain: API_ANALYTICS
category: REQUEST
description: Cycle Id cannot be empty.
'53115':
domain: API_ANALYTICS
category: REQUEST
description: Invalid cycle Id {cycleId}
'404':
description: Resource not found
'500':
description: Internal Server Error
x-response-codes:
errors:
'53120':
domain: API_ANALYTICS
category: APPLICATION
description: Internal server error. Wait a few minutes and try the call again. If error persists contact the eBay Developer Program.
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.analytics.readonly
/traffic_report:
get:
tags:
- traffic_report
description: This method returns a report that details the user traffic received by a seller's listings.
A traffic report gives sellers the ability to review how often their listings appeared on eBay, how many times their listings are viewed, and how many purchases were made. The report also returns the report's start and end dates, and the date the information was last updated.
For more information, see Traffic report details
operationId: getTrafficReport
parameters:
- name: dimension
in: query
description: 'This query parameter specifies the dimension, or "attribute," that is applied to the report metric.
Valid values: DAY
or LISTING
Examples - If you specify
dimension=DAY
and metric=CLICK_THROUGH_RATE
, the traffic report contains the number of times an item displayed on a search results page and the buyer clicked through to the View Item page for each day in the date range, as in:
12-06-17: 32, 12-07-17: 54, ...
- If you specify
dimension=LISTING
and metric=LISTING_IMPRESSION_STORE
, the traffic report contains the number of times that listing appeared on the seller''s store during the specified date range.
For example, LISTING_IMPRESSION_STORE: 157
means the item appeared 157 times in the store during the date range. - If you specify
dimension=LISTING
without specifying any listing_ids in the parameter filter, the traffic report returned in the response contains a maximum of 200 listings.
'
required: false
schema:
type: string
- name: filter
in: query
description: 'This query parameter refines the information returned in the traffic report.
Note: URL encode all the values you supply in the filter parameter. See URL encoding query parameter values as described in URL parameters.
Configure the following properties of the filter parameter to tune the traffic report to your needs: - date_range
Limits the report to the specified range of dates. This value can be formatted in one of two ways depending on the user''s time zone.The maximum range between the start and end dates is 90 days, and the earliest start date you can specify is two years prior to the current date, which is defined as 730 days (365 * 2), not accounting for Leap Year.
The last date for which traffic data exists is a value called lastUpdatedDate. eBay returns an error if you specify a date range greater than 90 days, or the start date is after the lastUpdatedDate. If the specified end date is beyond the lastUpdatedDate, eBay returns data up to the lastUpdatedDate.
Required: Always - listing_ids
This filter limits the results to only the supplied list of listingId values.
Note: If you specify dimension=LISTING
without specifying any listing_ids in this parameter, the traffic report returned in the response contains a maximum of 200 listings.
You can specify to 200 different listingId values. Enclose the list of IDs with curly braces ("{ }
"), and separate multiple values with a pipe character ("|
").
This filter only returns data for listings that have been either active or sold in last 90 days, and any unsold listings in the last 30 days. All listings must be the seller''s and they must be listed on the marketplace specified by the marketplace_ids filter argument. - marketplace_ids
This filter limits the report to seller data related to only the specified marketplace ID (currently the filter allows only a single marketplace ID). Enclose the marketplace ID in curly braces ("{ }
").
Valid values: EBAY_AU
EBAY_DE
EBAY_ES
EBAY_FR
EBAY_GB
EBAY_IT
EBAY_US
EBAY_MOTORS_US
Required if you set the dimension parameter to DAY
.
Example filter parameter
The following example shows how to configure the filter parameter with the marketplace_ids and date_range filters: filter=marketplace_ids:{EBAY_US},date_range:[20170601..20170828]
Encoding this portion of the query parameter sample yields:
filter=marketplace_ids:%7BEBAY_US%7D,date_range:%5B20230601..20230828%5D
See samples for additional examples. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/analytics/types/csb:FilterField'
required: false
schema:
type: string
- name: metric
in: query
description: 'This query parameter specifies the metrics you want covered in the report.
Note: Unlike names for parameters and enumerated values, metric values are not case sensitive.
Valid values:Specify a comma-separated list of the metrics to include them in the report. See Using different metric parameters for more information including detailed metric descriptions and localized names.'
required: false
schema:
type: string
- name: sort
in: query
description: 'This query parameter sorts the report on the specified metric.
You can only specify a single metric in the sort parameter and the specified metric must be included in the configuration of the report''s metric parameter.
Sorting is helpful when you want to review how a specific metric is performing, such as the CLICK_THROUGH_RATE.
Most reports can be sorted in ascending or descending order. Precede the value of a descending-order request with a minus sign ("-
"), for example: sort=-CLICK_THROUGH_RATE
.
Note: There are a couple of constraints on sorting the report by different metrics:- Sorting on the
SALES_CONVERSION_RATE
metric is not supported - The
TRANSACTION
metric can only be sorted in the descending order (sorting in the ascending order is not supported).
For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/analytics/types/csb:SortField'
required: false
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
'400':
description: Bad Request
x-response-codes:
errors:
'50001':
domain: API_ANALYTICS
category: REQUEST
description: Invalid dimension specified. For help, see the documentation.
'50002':
domain: API_ANALYTICS
category: REQUEST
description: Invalid metric {metricName} specified. For help, see the documentation.
'50003':
domain: API_ANALYTICS
category: REQUEST
description: Invalid date range. End date must be before or equal to start date.
'50004':
domain: API_ANALYTICS
category: REQUEST
description: Invalid date range. Start date must be before or equal to end date.
'50005':
domain: API_ANALYTICS
category: REQUEST
description: No filter is specified, which is required. For help, see the documentation.
'50006':
domain: API_ANALYTICS
category: REQUEST
description: The sort field value {sortField} is not supported.
'50008':
domain: API_ANALYTICS
category: REQUEST
description: The call requires at least one metric. For help, see the documentation.
'50009':
domain: API_ANALYTICS
category: REQUEST
description: The call requires at least one URI query parameter. For help, see the documentation.
'50013':
domain: API_ANALYTICS
category: REQUEST
description: Invalid date range format - Start Date. The format is yyyyMMdd.
'50014':
domain: API_ANALYTICS
category: REQUEST
description: Invalid date range format - End Date. The format is yyyyMMdd.
'50018':
domain: API_ANALYTICS
category: REQUEST
description: Neither the start date nor the end date can be in the future.
'50021':
domain: API_ANALYTICS
category: REQUEST
description: Invalid filter field {filterField} specified.
'50022':
domain: API_ANALYTICS
category: REQUEST
description: Specify at least one marketplace ID.
'50023':
domain: API_ANALYTICS
category: REQUEST
description: The marketplace ID {marketplaceId} is not supported by this call. For help, see the documentation.
'50024':
domain: API_ANALYTICS
category: REQUEST
description: The marketplace ID {marketplaceId} is not valid.
'50025':
domain: API_ANALYTICS
category: REQUEST
description: The start date is too far in the past. The start date must be less than or equal to {maxStartDateInThePast}.
'50026':
domain: API_ANALYTICS
category: REQUEST
description: The date range is too long. The date range must be less than or equal to {maxDateWindow}.
'50027':
domain: API_ANALYTICS
category: REQUEST
description: The 'listing_id' value is empty.
'50028':
domain: API_ANALYTICS
category: REQUEST
description: The maximum number of listing IDs has been exceeded. The maximum number of listing IDs is {maxListingIdsNumber}.
'50029':
domain: API_ANALYTICS
category: REQUEST
description: Invalid listing ID {listingId}.
'50030':
domain: API_ANALYTICS
category: REQUEST
description: Data for the listing ID {listingId} could not be found.
'50031':
domain: API_ANALYTICS
category: REQUEST
description: Date range is required.
'50033':
domain: API_ANALYTICS
category: REQUEST
description: Invalid date range filter format {invalidDateRangeFilter}.
'50034':
domain: API_ANALYTICS
category: REQUEST
description: Invalid listing ids filter format {invalidListingIdsFilter}.
'50035':
domain: API_ANALYTICS
category: REQUEST
description: Requested sort field is not part of the list of metrics requested.
'50036':
domain: API_ANALYTICS
category: REQUEST
description: '{sortOrder} sort order is not supported for {sortField} metric.'
'50037':
domain: API_ANALYTICS
category: REQUEST
description: The Metric {metricName} does not have data available for the requested date range.
'50600':
domain: API_ANALYTICS
category: REQUEST
description: Data for the listing Ids {delayedListingIds} is not yet updated to {endDate}
'500':
description: Internal Server Error
x-response-codes:
errors:
'50032':
domain: API_ANALYTICS
category: APPLICATION
description: We are unable to process data for accounts, like this one, which have listed in more than a few thousand leaf categories in the past couple years.
'50050':
domain: API_ANALYTICS
category: APPLICATION
description: We are doing some maintenance and cannot show all your information right now. We are still tracking everything, and you will see your updated stats soon.
'50500':
domain: API_ANALYTICS
category: APPLICATION
description: Internal server error. Wait a few minutes and try the call again. If error persists contact the eBay Developer Program.
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.analytics.readonly
components:
schemas:
BenchmarkMetadata:
type: object
properties:
average:
type: string
description: This field returns the average value for the group, as defined by the specified basis.
When the benchmark basis is set to PEER_BENCHMARK
, the value returned in this field is the benchmark value to which the seller's metric value is compared to determine the seller's rating for the customer service metric.
description: This complex type defines the fields that comprise the benchmark against which the seller's performance is compared. The comparison determines the seller's rating for the metric.
Cycle:
type: object
properties:
cycleType:
type: string
description: The cycle type, either CURRENT
or PROJECTED
.
CURRENT
means the profile's metrics values are from the most recent official eBay monthly standards evaluation. PROJECTED
means the profile values were determined when the profile was requested. For implementation help, refer to eBay API documentation
evaluationDate:
type: string
description: The date and time at which the standard compliance values were determined for the profile.
The time stamp is formatted as an ISO 8601 string, which is based on the 24-hour Universal Coordinated Time (UTC) clock.
Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2018-08-04T07:09:00.000Z
evaluationMonth:
type: string
description: The month in which the currently effective seller level was computed.
The value is always formatted as YYYY-MM
. If the cycle is CURRENT
, this value is the month and year the of the last eBay compliance evaluation. If this is for a PROJECTED
cycle, the value is the month and year of the next scheduled evaluation. Because eBay does official evaluations around the 20th of each month, a PROJECTED
value may indicate either the current or the next month.
description: A complex type that describes a program cycle.
Definition:
type: object
properties:
dataType:
type: string
description: Indicates the data type of the returned dimension. For example, if the dimension is day
, the data type is DATE
. For implementation help, refer to eBay API documentation
key:
type: string
description: The value the dimension or metric parameter as submitted in the request.
localizedName:
type: string
description: The localized name of the metric or dimension (translated into the language specified in the Accept-Language HTTP request header). For example, if Accept-Language is set to de-DE
, the value "day" in the dimension container is returned as "tag", and a metric of TRANSACTION is returned as "Transaktionsanzahl".
description: A complex type that defines a dimension key and metrics in a traffic report.
Dimension:
type: object
properties:
dimensionKey:
type: string
description: 'dimensionKey defines the basis against which the seller''s customer service metric is measured.
The value of this field gets set according to the value of the customer_service_metric_type input parameter. The following input configurations return the responses shown: ITEM_NOT_AS_DESCRIBED
– Returns benchmark ratings based on L1 listing categories, so the result shows metrics where the dimensionKey is set to LISTING_CATEGORY
. ITEM_NOT_RECEIVED
– Returns benchmark ratings based on world shipping regions, so the result shows metrics where the dimensionKey is set to SHIPPING_REGION
.
The shipping region is indicated by the associated value field. For specifics on world shipping regions, see the FAQ section on the following page: Monitor your service metrics
For implementation help, refer to eBay API documentation'
name:
type: string
description: 'The dimension name returned in this field depends on the dimensionKey: - If dimensionKey is set to
SHIPPING_REGION
, this field is set to one of following values, which represent established shipping corridors: Domestic
International: Mature region
International: Emerging region
- If dimensionKey is set to
LISTING_CATEGORY
, this field is set to the name of the primary (L1) category in which the items being rated were listed.
'
value:
type: string
description: 'The value returned in this field depends on the dimensionKey.
If dimensionKey equals LISTING_CATEGORY
, the value returned in this field is the category ID of the primary (L1) category in which the items being rated were listed.
If dimensionKey equals SHIPPING_REGION
, one of the following values is returned: DOMESTIC
INTERNATIONAL_MATURED_REGION
INTERNATIONAL_EMERGING_REGION
'
description: The fields in this complex type define the dimension, or attributes, by which the associated customer service metric and benchmark data is measured.
The value of dimensionKey gets set according to the configuration of the input request. The name and value pair further define dimension under the key.
DimensionMetric:
type: object
properties:
dimension:
description: This type defines the "dimension," or attributes, against which the associated customer service metric values and benchmark ratings are based.
The dimensionKey value is set according to the customer_service_metric_type request parameter and the values in the associated name/value pairs relate to the dimensionKey that's being used to calculate the benchmark rating.
$ref: '#/components/schemas/Dimension'
metrics:
type: array
description: This is a list of Metric elements where each element contains data and information related to the transactions grouped by the associated dimension.
items:
$ref: '#/components/schemas/Metric'
description: This complex type defines a the customer service metrics and seller benchmark performance related to a given dimension.
Distribution:
type: object
properties:
name:
type: string
description: The name of a distribution in which the seller is active.
value:
type: string
description: This field contains the number of transactions the seller had in the distribution (identified by the associated name field) during the metric evaluationCycle.
description: This complex type defines of a piece of data that is grouped by the associated basis. It contains the name for the data set and its associated value.
Error:
type: object
properties:
category:
type: string
description: Identifies whether the error was in the REQUEST or happened when running the APPLICATION.
domain:
type: string
description: The primary system where the error occurred. This is relevant for application errors. For Analytics errors, it always has the value API_ANALYTICS
.
errorId:
type: integer
description: A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. Traffic report error IDs range from 50001 to 50500.
format: int32
inputRefIds:
type: array
description: Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation.
items:
type: string
longMessage:
type: string
description: A more detailed explanation of the error than given in the message
error field.
message:
type: string
description: Information on how to correct the problem, in the end user's terms and language where applicable. Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale.
outputRefIds:
type: array
description: Identifies specific response elements associated with the error, if any. Path format is the same as inputRefId
.
items:
type: string
parameters:
type: array
description: This optional list of name/value pairs that contain context-specific ErrorParameter
objects, with each item in the list being a parameter (or input field name) that caused an error condition. Each ErrorParameter
object consists of two fields, a name
and a value
.
items:
$ref: '#/components/schemas/ErrorParameter'
subdomain:
type: string
description: If present, indicates which subsystem in which the error occurred.
description: Type that defines the fields that can be returned in an error.
ErrorParameter:
type: object
properties:
name:
type: string
description: Name of the entity that threw the error.
value:
type: string
description: A description of the error.
description: A complex type that defines an error and error message.
EvaluationCycle:
type: object
properties:
endDate:
type: string
description: End date and time of the transaction lookback range. All timestamps are based on Mountain Standard Time (MST).
The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.
evaluationDate:
type: string
description: The ISO-8601 date and time at which the seller was evaluated for this customer service metric rating.
evaluationType:
type: string
description: 'This field specifies the transaction lookback period used for the evaluation.
The evaluation_type value specified in the request is returned in this field. There are two possible values: CURRENT
– A monthly evaluation that occurs on the 20th of every month. PROJECTED
– A daily evaluation that provides a projection of how the seller is currently performing with regards to the upcoming evaluation period.
For implementation help, refer to eBay API documentation'
startDate:
type: string
description: The start date and time of the transaction lookback range. All timestamps are based on Mountain Standard Time (MST).
The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.
Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2018-08-04T07:09:00.000Z
description: This complex type describes the start and end dates of the of the time period over which the associated benchmark is computed.
All timestamps are based on Mountain Standard Time (MST).
The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.
FindSellerStandardsProfilesResponse:
type: object
properties:
standardsProfiles:
type: array
description: A list of the seller's standards profiles.
A "standards profile" is a set of eBay seller standards categories and the values related to the associated seller.
Profiles are distinguished by a combination of cycle and program values. The "program" value specifies the region to which the data is from. The "cycle" value specifies whether the values were determined just now, or if the values are from the last official eBay seller standards evaluation.
items:
$ref: '#/components/schemas/StandardsProfile'
description: The response container for a list of seller profiles.
GetCustomerServiceMetricResponse:
type: object
properties:
dimensionMetrics:
type: array
description: 'This container provides a seller''s customer service metric performance for a given dimension.
In the getCustomerServiceMetric request, specify values for the following request parameters to control the returned dimension and the associated metric values: - customer_service_metric_type
- evaluation_type
- evaluation_marketplace_id
'
items:
$ref: '#/components/schemas/DimensionMetric'
evaluationCycle:
description: This complex type defines the evaluation type (CURRENT
or PROJECTED
) and the transaction lookback period used to calculate the seller's customer service metric.
$ref: '#/components/schemas/EvaluationCycle'
marketplaceId:
type: string
description: The eBay marketplace ID of the marketplace upon which the customer service metric evaluation is based.
The customer_service_metric resource supports a limited set of marketplaces. For a complete list of the supported marketplaces, please see the Service metrics policy page. For implementation help, refer to eBay API documentation
description: This complex data type defines the response data that is returned from a request to getCustomerServiceMetric.
The dimensionMetrics object contains the details of the dimension being measured and the calculated customer service metric values.
The evaluationCycle defines the period used to calculate the metric values.
The marketplaceId is the eBay marketplace for which the metrics are being considered.
Header:
type: object
properties:
dimensionKeys:
type: array
description: A list of the dimension or metric keys returned in the report. The values for each are is returned in the associated key fields.
items:
$ref: '#/components/schemas/Definition'
metrics:
type: array
description: The list of metrics returned in the report. The values for each are is returned in the associated key fields.
items:
$ref: '#/components/schemas/Definition'
description: Type that defines the headers for the dimension keys and metrics returned in the report.
Metadata:
type: object
properties:
metadataHeader:
description: The container that returns the dimensionKeys and metrics headers for the report.
$ref: '#/components/schemas/MetadataHeader'
metadataRecords:
type: array
description: A list of the individual report records.
items:
$ref: '#/components/schemas/MetadataRecord'
description: Type the defines the metadata information of the report. This includes the headers and the individual metadata records.
MetadataHeader:
type: object
properties:
key:
type: string
description: 'The key value used for the report.
For example: "key": "LISTING_ID"
'
metadataKeys:
type: array
description: 'The list of dimension key values used for the report header. Each list element contains the key name, its data type, and its localized name.
For example: "metadataKeys": [
"key": "LISTING_TITLE",
"localizedName": "Listing title",
"dataType": "STRING"
'
items:
$ref: '#/components/schemas/Definition'
description: Type that defines the metadata header fields.
MetadataRecord:
type: object
properties:
metadataValues:
type: array
description: A list of data in a row returned in the traffic report. The data in each of the cells match the labels in headers of the report.
items:
$ref: '#/components/schemas/Value'
value:
description: 'The value of the key on which the report is based.
For example, if the key is the listing ID, the value of this container could be:
"value": {
"value": "142133954229",
"applicable": true
}
'
$ref: '#/components/schemas/Value'
description: A complex type that defines the data records returned in the report.
Metric:
type: object
properties:
benchmark:
description: This complex type defines a set of benchmark data, which includes the average rating for the group included in the benchmark evaluation and the seller's calculated customer service metric rating for the benchmark.
This container is returned only if the associated metricKey value is RATE
.
$ref: '#/components/schemas/MetricBenchmark'
distributions:
type: array
description: Returned when metricKey equals COUNT
, this field returns an array of seller data where each set of data is grouped according by an overarching basis.
When the seller distribution is returned, the numeric value of the associated value container equals the sum of the transactions where the seller meets the criteria of the customer service metric type for the given dimension during the evaluationCycle.
items:
$ref: '#/components/schemas/MetricDistribution'
metricKey:
type: string
description: 'This field indicates the customer service metric being returned in the associated metrics container. The field is set as follows: TRANSACTION_COUNT
– When set to this value, the associated value field returns the number of transactions completed in the peer group for the metric being evaluated in the associated dimension and evaluationCycle. COUNT
– When set to this value, the associated value field is set to the number of transactions completed by the seller for the metric being evaluated in the associated dimension and evaluationCycle. RATE
– When set to this value, the fields in the associated container return the seller''s calculated value for the associated customer service metric along with the benchmark data against which the seller is evaluated.
Specifically, when metricKey is set to RATE
, the associated value field is set to the value of metricKey TRANSACTION_COUNT
divided by the value of metricKey COUNT
.
The benchmark.rating value is the seller''s rating for the metric in the associated dimension and evaluationCycle.
'
value:
type: string
description: This field is set to the seller's numeric rating for the associated metricKey for the given dimension during the evaluationCycle.
To determine the seller's rating for this metric, the value of this field is compared to the average metric value of the group.
description: This complex data type defines the details of the customer service metric and benchmark data related to the associated dimension.
MetricBenchmark:
type: object
properties:
adjustment:
type: string
description: If this field is present, it indicates that the rating given to the seller was "adjusted" for one reason or another.
If eBay determines that the normal rating of a seller is impacted by circumstances beyond their control, they can issue an override to adjust the rating given to the seller. For implementation help, refer to eBay API documentation
basis:
type: string
description: This field returns the "basis" by which the benchmark is calculated for the customer service metric type.
Currently, the only supported basis is PEER_BENCHMARK
. For implementation help, refer to eBay API documentation
metadata:
description: This field contains the benchmark data.
$ref: '#/components/schemas/BenchmarkMetadata'
rating:
type: string
description: This field returns seller's rating for the customer service metric.
The rating is set to a value that equals the relative deviation between the seller's metric value and the benchmark value for the customer service metric.
Deviation values range from LOW
to VERY HIGH
, and the lower the deviation, the better the seller rating. For implementation help, refer to eBay API documentation
description: This complex type defines the benchmark data, which includes the average value of the metric for the group (the benchmark) and the seller's overall rating when compared to the benchmark.
MetricDistribution:
type: object
properties:
basis:
type: string
description: This field returns the basis, or the method, by which the metric rating is calculated.
data:
type: array
description: This field returns a list of name/value pairs, where the name indicates the distribution being rated and the value indicates the count of seller transactions that meet the distribution criteria.
items:
$ref: '#/components/schemas/Distribution'
description: This complex data type describes the metric distribution by basis.
Record:
type: object
properties:
dimensionValues:
type: array
description: A list where each element contains either the string DAY
(if the dimension is DAY
), or the listing ID for which the record's metric data is computed. A second array member, applicable, is always true
for dimension values.
items:
$ref: '#/components/schemas/Value'
metricValues:
type: array
description: A list where each element contains a value field that indicates the record's value for the metric. Each element also contains an applicable field that indicates the veracity of the computed value.
Note that there are no metric names or IDs associated with the values returned in this array. The metadata to which these values relate can be found in the key values in metadataKeys. The order of the metric values in this array equals the order of the key values in metadataHeader.
items:
$ref: '#/components/schemas/Value'
description: Type that defines the fields of the individual record of the report.
Report:
type: object
properties:
dimensionMetadata:
type: array
description: A complex type containing the header of the report and the type of data containted in the rows of the report.
items:
$ref: '#/components/schemas/Metadata'
endDate:
type: string
description: '
The time stamp is formatted as an ISO 8601 string, which is based on the 24-hour Universal Coordinated Time (UTC) clock.
If you specify an end date that is beyond the lastUpdatedDate value, eBay returns a report that contains data only up to the lastUpdateDate date.
Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2018-08-20T07:09:00.000Z
'
header:
description: A complex type containing the header for the report.
$ref: '#/components/schemas/Header'
lastUpdatedDate:
type: string
description: The date and time, in ISO 8601 format, that indicates the last time the data returned in the report was updated.
records:
type: array
description: A complex type containing the individual data records for the traffic report.
items:
$ref: '#/components/schemas/Record'
startDate:
type: string
description: The start date of the date range used to calculate the report, in ISO 8601 format.
warnings:
type: array
description: An array of any process errors or warnings that were generated during the processing of the call processing.
items:
$ref: '#/components/schemas/Error'
description: The complex type that defines that defines the report.
StandardsProfile:
type: object
properties:
cycle:
description: A complex type that specifies the profile's evaluation cycle (CURRENT
or PROJECTED
), the date the evaluation was calculated, and the month to which the evaluation pertains.
Each program has at least one cycle, but a program can include both cycle types.
$ref: '#/components/schemas/Cycle'
defaultProgram:
type: boolean
description: If set to true
, this flag indicates this is the default program for the seller.
Except for sellers in China, a seller's default program is the marketplace where they registered with eBay. Seller's in China select their default program when they register.
evaluationReason:
type: string
description: Specifies how the overall seller level was calculated.
In the event of special circumstances (as determined by eBay), eBay may override the calculated seller level. In general, such overrides protect a seller's level. The usual value for both cycle types is "Seller level generated by standards monthly evaluation cycle."
metrics:
type: array
description: A list of the metrics upon which a seller's profile is evaluated.
Each program's applicable metrics and requirements are listed at eBay Top Rated seller program standards.
items:
$ref: '#/components/schemas/Metric'
program:
type: string
description: Indicates the program used to generate the profile data. Values can be PROGRAM_DE
, PROGRAM_UK
, PROGRAM_US
, or PROGRAM_GLOBAL
. For implementation help, refer to eBay API documentation
standardsLevel:
type: string
description: The overall standards level of the seller, one of TOP_RATED
, ABOVE_STANDARD
, or BELOW_STANDARD
. For implementation help, refer to eBay API documentation
description: A complex type that defines a seller profile.
Value:
type: object
properties:
applicable:
type: boolean
description: 'If set to true
, this flag indicates the value in the value field is valid as computed.
A value of false
indicates one or more of the values used to calculate the value was invalid. The occurrence of this is a rare, however consider this case: suppose a buyer navigates to a View Item page at 11:59 pm (the end of the day) and purchases the item at 12:05am the next day. In this case, the item would have been purchased with 0
views for the day.'
value:
type: object
description: The value of the report data.
description: A complex type that contains a value, plus the veracity of that value.
securitySchemes:
api_auth:
type: oauth2
description: The security definitions for this API. Please check individual operations for applicable scopes.
flows:
authorizationCode:
authorizationUrl: https://auth.ebay.com/oauth2/authorize
tokenUrl: https://api.ebay.com/identity/v1/oauth2/token
scopes:
https://api.ebay.com/oauth/api_scope/sell.analytics.readonly: View your selling analytics data, such as performance reports