eBay Analytics API
The eBay Analytics API provides sellers with key performance metrics, traffic reports, customer service metrics, and seller standards information so they can measure and improve their performance on eBay.
OpenAPI Specification
openapi: 3.0.0
info:
title: "eBay Seller Service Metrics API"
description: 'The <i>Analytics API</i> provides data and information about a seller and their eBay business. <br><br>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. <br><br>The three resources in the Analytics API provide the following data and information: <ul><li><b>Customer Service Metric</b> – 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.</li> <li><b>Traffic Report</b> – Returns data and information that shows how buyers are engaging with a seller''s listings.</li> <li><b>Seller Standards Profile</b> – Returns information pertaining to a seller''s profile rating.</li></ul> 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. <br><br>For details on using this API, see <a href="/api-docs/sell/static/performance/analyzing-performance.html" title="Selling Integration Guide">Analyzing seller performance</a>.'
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. <br><br>Control the response from the <b>getCustomerServiceMetric</b> method using the following path and query parameters: <ul><li><b>customer_service_metric_type</b> controls the type of customer service transactions evaluated for the metric rating.</li> <li><b>evaluation_type</b> controls the period you want to review.</li> <li><b>evaluation_marketplace_id</b> specifies the target marketplace for the evaluation.</li></ul> Currently, metric data is returned for only peer benchmarking. For details on the workings of peer benchmarking, see <a href="https://www.ebay.com/help/policies/selling-policies/seller-performance-policy/service-metrics-policy?id=4769" title="eBay Help pages" target="_blank">Service metrics policy</a>. <br><br>For details on using and understanding the response from this method, see <a href="/api-docs/sell/static/performance/customer-service-metric.html" title="Selling Integration Guide">Interpreting customer service metric ratings</a>.'
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:<br> <ul><li><code>ITEM_NOT_AS_DESCRIBED</code></li><li><code>ITEM_NOT_RECEIVED</code></li></ul>
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. <br><br>For the list of supported marketplaces, see <a href="/api-docs/sell/analytics/static/overview.html#requirements" title="Analytics API Overview" target="_blank">Analytics API requirements and restrictions</a>. 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 <a href="/api-docs/sell/analytics/types/api:EvaluationTypeEnum" target="_blank"> EvaluationTypeEnum</a> 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. <br><br>A <i>standards profile </i> is a set of eBay seller metrics and the seller's associated compliance values (either <code>TOP_RATED</code>, <code>ABOVE_STANDARD</code>, or <code>BELOW_STANDARD</code>). <br><br>A seller's multiple profiles are distinguished by two criteria, a "program" and a "cycle." A profile's <i>program </i> is one of three regions where the seller may have done business, or <code>PROGRAM_GLOBAL</code> to indicate all marketplaces where the seller has done business. The <i>cycle</i> 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. <br><br>A <i>standards profile </i> is a set of eBay seller metrics and the seller's associated compliance values (either <code>TOP_RATED</code>, <code>ABOVE_STANDARD</code>, or <code>BELOW_STANDARD</code>). <br><br>A seller can have multiple profiles distinguished by two criteria, a "program" and a "cycle." A profile's <i>program </i> is one of three regions where the seller may have done business, or <code>PROGRAM_GLOBAL</code> to indicate all marketplaces where the seller has done business. The <i>cycle</i> value specifies whether the standards compliance values were determined at the last official eBay evaluation (<code>CURRENT</code>) or at the time of the request (<code>PROJECTED</code>). 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.<br><br>See <a href="/api-docs/sell/analytics/types/ssp:CycleTypeEnum" target="_blank">CycleTypeEnum</a> 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. <br><br>See <a href="/api-docs/sell/analytics/types/ssp:ProgramEnum" target="_blank">ProgramEnum</a> 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. <br><br>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. <br><br>For more information, see <a href="/api-docs/sell/static/performance/traffic-report.html" target="_blank">Traffic report details</a>
operationId: getTrafficReport
parameters:
- name: dimension
in: query
description: 'This query parameter specifies the <i>dimension</i>, or "attribute," that is applied to the report <b>metric</b>. <br><br><b>Valid values:</b> <code>DAY</code> or <code>LISTING</code> <br><br><b>Examples</b> <ul><li>If you specify <code>dimension=DAY</code> and <code>metric=CLICK_THROUGH_RATE</code>, 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: <br><code>12-06-17: 32, 12-07-17: 54, ...</code></li> <li>If you specify <code>dimension=LISTING</code> and <code>metric=LISTING_IMPRESSION_STORE</code>, the traffic report contains the number of times that listing appeared on the seller''s store during the specified date range. <br><br>For example, <code>LISTING_IMPRESSION_STORE: 157</code> means the item appeared 157 times in the store during the date range.</li><li>If you specify <code>dimension=LISTING</code> without specifying any <b>listing_ids</b> in the parameter filter, the traffic report returned in the response contains a maximum of 200 listings.</li></ul> <!-- Dimension - Enables user to specify input to slice the data that the user is interested in - For example specify listing and days as dimensions to get traffic report for all the sellers listings grouped by listing and days. Refer to DimensionEnum) -->'
required: false
schema:
type: string
- name: filter
in: query
description: 'This query parameter refines the information returned in the traffic report. <br><p><span class="tablenote"><b>Note: </b> URL encode all the values you supply in the <b>filter</b> parameter. See <b>URL encoding query parameter values</b> as described in <a href="/api-docs/static/rest-request-components.html#parameters" target="_blank">URL parameters</a>.</span></p>Configure the following properties of the <b>filter</b> parameter to tune the traffic report to your needs: <ul> <li><b>date_range</b> <br>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.<ul><li><b>For America/Los_Angeles time zone</b>, input the date range using <code>YYMMDD</code> 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 ("<code>[ ]</code>"), as follows:<br><br><code>[YYYYMMDD..YYYYMMDD]</code><br><br>For example:<br><pre>[20240101..20240131]</pre></li><li><b>For all other time zones</b>, input the date range using <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format, and specify the time zone using a UTC offset. A time zone offset is a positive or negative value that represents the number of hours a time zone is from UTC (see <a href="https://www.utctime.net/utc-time-zone-converter" target="_blank">UTC Time Zone Converter</a> for offset values for your time zone). Enclose the earliest date and end date for the report in brackets ("<code>[ ]</code>"), as follows:<br><br><code>[yyyy-MM-dd''T''HH:mm:ss.SSS+|-hh:mm..yyyy-MM-dd''T''HH:mm:ss.SSS+|-hh:mm]</code><br><br>For example:<br><pre>[2024-01-01T02:00:00.000-05:00..2024-01-31T02:00:00.000-05:00]</pre><span class="tablenote"><b>Note:</b> All time values entered in this format will be dropped, and will be replaced with <code>00:00:00.000</code> for <b>startDate</b> and <code>23:59:59.000</code> for <b>endDate</b> in the response body.</span></li></ul>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.<br><br><a name="lastUDate"></a>The last date for which traffic data exists is a value called <b>lastUpdatedDate</b>. 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.<br><br><b>Required:</b> Always</li> <li><b>listing_ids</b> <br>This filter limits the results to only the supplied list of <b>listingId</b> values. <br><br><span class="tablenote"><b>Note:</b> If you specify <code>dimension=LISTING</code> without specifying any listing_ids in this parameter, the traffic report returned in the response contains a maximum of 200 listings.</span><br>You can specify to 200 different <b>listingId</b> values. Enclose the list of IDs with curly braces ("<code>{ }</code>"), and separate multiple values with a pipe character ("<code>|</code>"). <br><br>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 <b>marketplace_ids</b> filter argument.</li> <li><b>marketplace_ids</b> <br>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 ("<code>{ }</code>"). <br><br><b>Valid values:</b> <ul class="compact"><li><code>EBAY_AU</code></li> <li><code>EBAY_DE</code></li><li><code>EBAY_ES</code></li><li><code>EBAY_FR</code></li> <li><code>EBAY_GB</code></li> <li><code>EBAY_IT</code></li><li><code>EBAY_US</code></li> <li><code>EBAY_MOTORS_US</code></li></ul> <br><b>Required if</b> you set the
<b>dimension</b> parameter to <code>DAY</code>.</li></ul> <br><b>Example filter parameter</b> <br>The following example shows how to configure the <b>filter</b> parameter with the <b>marketplace_ids</b> and <b>date_range</b> filters: <p><code>filter=marketplace_ids:{EBAY_US},date_range:[20170601..20170828]</code><br><br>Encoding this portion of the query parameter sample yields: <p><code>filter=marketplace_ids:%7BEBAY_US%7D,date_range:%5B20230601..20230828%5D</code> </p><br>See <a href=" /api-docs/sell/analytics/resources/traffic_report/methods/getTrafficReport#h2-samples">samples</a> for additional examples.<!-- **Filter results based on the specified filter parameters- window_days (WindowDaysEnum), date_range, marketplace_id (MarketplaceIdEnum - Only EBAY_US, EBAY_MOTORS_US, EBAY_GB, EBAY_AU, EBAY_DE are supported), listing_ids, traffic_source (Takes a list. Supported values: ORGANIC, PROMOTED_LISTINGS). Valid filters come from QueryParamEnum --> 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: '<a name="metrics"></a>This query parameter specifies the metrics you want covered in the report. <br><p><span class="tablenote"><b>Note: </b> Unlike names for parameters and enumerated values, metric values are not case sensitive.</span></p><b>Valid values:</b><ul> <li><a href="/api-docs/sell/static/performance/traffic-report.html#click_through_rate" target="_blank">CLICK_THROUGH_RATE</a></li> <li><a href="/api-docs/sell/static/performance/traffic-report.html#listing_impression_search_results_page" target="_blank">LISTING_IMPRESSION_SEARCH_RESULTS_PAGE</a> </li> <li><a href="/api-docs/sell/static/performance/traffic-report.html#listing_impression_store" target="_blank">LISTING_IMPRESSION_STORE</a></li> <li><a href="/api-docs/sell/static/performance/traffic-report.html#listing_impression_total" target="_blank">LISTING_IMPRESSION_TOTAL</a></li> <li><a href="/api-docs/sell/static/performance/traffic-report.html#listing_views_source_direct" target="_blank">LISTING_VIEWS_SOURCE_DIRECT</a></li> <li><a href="/api-docs/sell/static/performance/traffic-report.html#listing_views_source_off_ebay" target="_blank">LISTING_VIEWS_SOURCE_OFF_EBAY</a></li> <li><a href="/api-docs/sell/static/performance/traffic-report.html#listing_views_source_other_ebay" target="_blank">LISTING_VIEWS_SOURCE_OTHER_EBAY</a></li> <li><a href="/api-docs/sell/static/performance/traffic-report.html#listing_views_source_search_results_page" target="_blank">LISTING_VIEWS_SOURCE_SEARCH_RESULTS_PAGE</a></li> <li><a href="/api-docs/sell/static/performance/traffic-report.html#listing_views_source_store" target="_blank">LISTING_VIEWS_SOURCE_STORE</a></li> <li><a href="/api-docs/sell/static/performance/traffic-report.html#listing_views_total" target="_blank">LISTING_VIEWS_TOTAL</a></li> <li><a href="/api-docs/sell/static/performance/traffic-report.html#sales_conversion_rate" target="_blank">SALES_CONVERSION_RATE</a></li> <li><a href="/api-docs/sell/static/performance/traffic-report.html#total_impression_total" target="_blank">TOTAL_IMPRESSION_TOTAL</a></li> <li><a href="/api-docs/sell/static/performance/traffic-report.html#transaction" target="_blank">TRANSACTION</a></li></ul>Specify a comma-separated list of the metrics to include them in the report. See <a href="/api-docs/sell/static/performance/traffic-report.html#metric-parameters" target="_blank">Using different metric parameters</a> for more information including detailed metric descriptions and localized names.<!-- Metric - Lets the user specify the list of fields that they would like to see in the report. Allowed values: CLICK_THROUGH_RATE, LISTING_IMPRESSION_SEARCH_RESULTS_PAGE, LISTING_IMPRESSION_STORE, LISTING_IMPRESSION_TOTAL, LISTING_VIEWS_SOURCE_DIRECT, LISTING_VIEWS_SOURCE_OFF_EBAY, LISTING_VIEWS_SOURCE_OTHER_EBAY, LISTING_VIEWS_SOURCE_SEARCH_RESULTS_PAGE, LISTING_VIEWS_SOURCE_STORE, LISTING_VIEWS_TOTAL, SALES_CONVERSION_RATE (DataMetricEnum), TOTAL_IMPRESSION_TOTAL, TRANSACTION -->'
required: false
schema:
type: string
- name: sort
in: query
description: 'This query parameter sorts the report on the specified metric. <br><br>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 <a href="#metrics">metric</a> parameter. <br><br>Sorting is helpful when you want to review how a specific metric is performing, such as the CLICK_THROUGH_RATE. <br><br>Most reports can be sorted in ascending or descending order. Precede the value of a descending-order request with a minus sign ("<code>-</code>"), for example: <code>sort=-CLICK_THROUGH_RATE</code>.<br /><br /><span class="tablenote"><b>Note:</b> There are a couple of constraints on sorting the report by different metrics:<ul><li>Sorting on the <code>SALES_CONVERSION_RATE</code> metric is not supported</li><li>The <code>TRANSACTION</code> metric can only be sorted in the descending order (sorting in the ascending order is not supported).</li></ul></span> <!-- Sort order for a collection of resources: Specify the metric value to be sorted. Allowed values are from DataMetricEnum --> 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 <b>basis</b>. <br><br>When the benchmark <b>basis</b> is set to <code>PEER_BENCHMARK</code>, the value returned in this field is the benchmark value to which the seller's metric <b>value</b> 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 <code>CURRENT</code> or <code>PROJECTED</code>. <br><br><code>CURRENT</code> means the profile's metrics values are from the most recent official eBay monthly standards evaluation. <code>PROJECTED</code> means the profile values were determined when the profile was requested. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/analytics/types/ssp:CycleTypeEnum'>eBay API documentation</a>
evaluationDate:
type: string
description: The date and time at which the standard compliance values were determined for the profile. <br><br>The time stamp is formatted as an <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> string, which is based on the 24-hour Universal Coordinated Time (UTC) clock. <br><br><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code> <br><b>Example:</b> <code>2018-08-04T07:09:00.000Z</code>
evaluationMonth:
type: string
description: The month in which the currently effective seller level was computed. <br><br>The value is always formatted as <code>YYYY-MM</code>. If the cycle is <code>CURRENT</code>, this value is the month and year the of the last eBay compliance evaluation. If this is for a <code>PROJECTED</code> 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 <code>PROJECTED</code> 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 <b>dimension</b> is <code>day</code>, the data type is <code>DATE</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/analytics/types/ssp:DataTypeEnum'>eBay API documentation</a>
key:
type: string
description: The value the <b>dimension</b> or <b>metric</b> parameter as submitted in th
# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ebay/refs/heads/main/openapi/ebay-analytics-openapi-original.yml