analytics API1.2.0

The Analytics API

The Analytics API provides information about an individual seller’s business through different report and data gathering resources:

  • Customer service metric ratings and benchmark data

  • The Traffic Report
  • The Seller Standard Profiles Report

Understanding the health and performance of your business is crucial to maintaining and planning your business growth.

The methods in the Analytics API return metric ratings and information that

  • Traffic reports gives you insight in how buyers engage with your listings
  • Customer service metrics detail how you are meeting buyers’ customer-service expectations
  • Seller profiles detail the returns the eBay seller rating of a seller in the regions in which the seller is active.

The calls in the API support reporting changes over time, and depending on your trading history, you might have multiple years of available data to work with. You can look at different history configurations to see how seasonal changes affect your business, or use the tools do an other time-based analysis.

This overview covers the following Seller Analytics API topics:

Technical overview

The Analytics API provides one or more methods in each of the following resources:

  • customer_service_metric
  • traffic_report
  • seller_standards_profile

The main objects in each resource are as follows:

  • Customer service metric
    • dimension - Specifies the attributes and time constraints that group the set of transactions used for the metric and benchmark data, and metric rating that's returned in the associated metric.
    • metric - Returns a set of metric and benchmark data, and the seller's metric rating, based on the transactions that meet the attributes defined by the associated dimension.

  • Traffic Report
    • dimensionKeys - the report's aggregation method, for example, days
    • metrics - the report's type of data, for example, total listing page views
    • records - the report's individual records, bucketed by dimensionKeys
  • Seller Standards Profile
    • program - marketplace region where a seller conducts business
    • cycle - current or projected evaluation cycle

See the Business use cases section that follows for the details on how you can use these resources.

Business use cases

The following are some of the high-level use cases for the Analytics API:

Retrieve a seller's customer service metric rating

Use getCustomerServiceRating to retrieve metric data, which contains metric and benchmark data, and the customer service metric rating for a seller. The transactions considered for the data and rating are constrained by the attributes defined in the dimension.

Track buyer engagement with a seller's top listings

Some listings may generate the majority of your sales, by volume or by profit. It's important to know if links to these listings are showing up on eBay as often as you expect, or if buyers are starting to view or purchase those items less often than previous periods.

Benchmark buyer behavior on your listings over the past 2 years

You can compare buyer behavior on your listings over the past 2 years. This can help you understand when particular items are more likely to sell, or the information can let you know that interest in an item has declined steadily over time. For the latter, you might want to run a promotion to either try to revitalize sales or close out your inventory of the item.

Understand the impact of change on buyer engagement

Changes to listings can impact buyer engagement. For example, you can check to see if a marketing campaign has successfully led to more item views and sale conversions.

Correlate eBay standards performance to buyer engagement

You can correlate your eBay standards performance to engagement with your listings. For example, if you recently earned Top Rated Seller status, buyers may view and purchase your items more frequently due to the knowledge that you'll provide excellent customer service.

Monitor your eBay standards performance

Sellers can monitor their sales performance and evaluate the customer-service areas they can focus on to maintain or improve their evaluation. For example, you can focus on standards criteria in which you are not performing in the Top Rated Seller level.

Additional Information

More detailed reports on the various metrics can be found on the Seller Standards Dashboard. You may want to add these US program links to your dashboard.

Analytics API requirements and restrictions

Each resource, and its associated methods, are supported in distinct marketplaces, as outlined in the following sections.

customer_service_metric

The customer_service_metric resource has a single method, getCustomerServiceMetric, which is supported by the following eBay marketplaces:

  • Australia (EBAY_AU)
  • Canada (EBAY_CA)
  • France (EBAY_FR)
  • Germany (EBAY_DE)
  • Great Britain (EBAY_GB)
  • Italy (EBAY_IT)
  • Spain (EBAY_ES)
  • United States (EBAY_US)

For more information, see the Service metrics section of the Service metrics policy page.

traffic_report

The traffic_report resource has a single method, getCustomerServiceMetric, which is supported by the following eBay marketplaces:

  • Australia (EBAY_AU)
  • Germany (EBAY_DE)
  • Great Britain (EBAY_GB)
  • United States (EBAY_US)

Use this method for up to a few thousand listings per day; it is not intended to return daily metrics for all your listings. We hope to increase this rate limit In the future.

seller_standard_profile

The methods in the seller_standard_profile resource are supported by the same marketplaces that provide support for the customer_service_metric resource.

Be aware that some fields returned by the methods in the seller_standar_profile resource may be subject to change. This includes future possible updates to the structure of the program, metrics, cycle, and threshold response fields, so please code your applications to gracefully handle any such changes.