DAY or LISTING 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, ...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. LISTING_IMPRESSION_STORE: 157 means the item appeared 157 times in the store during the date range.dimension=LISTING without specifying any listing_ids in the parameter filter, the traffic report returned in the response contains a maximum of 200 listings.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:YYMMDD format. As this is the default time zone used for timestamps in the report, the time zone does not need to be specified. Enclose the earliest date and end date for the report in brackets ("[ ]"), as follows:[YYYYMMDD..YYYYMMDD][20240101..20240131]
[ ]"), as follows:[yyyy-MM-dd''T''HH:mm:ss.SSS+|-hh:mm..yyyy-MM-dd''T''HH:mm:ss.SSS+|-hh:mm][2024-01-01T02:00:00.000-05:00..2024-01-31T02:00:00.000-05:00]Note: All time values entered in this format will be dropped, and will be replaced with
00:00:00.000 for startDate and 23:59:59.000 for endDate in the response body.dimension=LISTING without specifying any listing_ids in this parameter, the traffic report returned in the response contains a maximum of 200 listings.{ }"), and separate multiple values with a pipe character ("|"). { }"). EBAY_AUEBAY_DEEBAY_ESEBAY_FREBAY_GBEBAY_ITEBAY_USEBAY_MOTORS_USDAY.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
Note: Unlike names for parameters and enumerated values, metric values are not case sensitive.
Valid values:-"), for example: sort=-CLICK_THROUGH_RATE.SALES_CONVERSION_RATE metric is not supportedTRANSACTION metric can only be sorted in the descending order (sorting in the ascending order is not supported).[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z 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.
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. 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.
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.
MetadataHeader:
type: object
properties:
key:
type: string
description: 'The key value used for the report. "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. "metadataKeys": [
"key": "LISTING_TITLE",
"localizedName": "Listing title",
"dataType": "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. 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.
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.
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.
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. "value": {
"value": "142133954229",
"applicable": true
}'
$ref: '#/components/schemas/Value'
description: A complex type that defines the data records returned in the report.
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.account.readonly: View your account settings
https://api.ebay.com/oauth/api_scope/sell.account: View and manage your account settings