ebay.com – sell-analytics

OpenAPI apis-guru ecommerce

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 data on a seller's customer service performance as compared to other seller's in the same peer group.
Traffic Report – Returns data that shows how buyers are engaging with a seller's listings.
Seller Standards Profile – Returns data pertaining to a seller's performance 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 .

Homepage: https://api.apis.guru/v2/specs/api.ebay.com:sell-analytics/1.2.0.json
Provider: api.ebay.com:sell-analytics / sell-analytics
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/api.ebay.com/sell-analytics/1.2.0/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/api.ebay.com/sell-analytics/1.2.0/openapi.yaml

Tools (6)

Extracted live via the executor SDK.

customerServiceMetric.getCustomerServiceMetric

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 more detail on the workings of peer benchmarking, see Service metrics policy.
sellerStandardsProfile.findSellerStandardsProfiles

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.
sellerStandardsProfile.getSellerStandardsProfile

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.
trafficReport.getTrafficReport

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. When using this call: Be sure to URL-encode the values you pass in query parameters, as described in URI parameters. See the request samples below for details. You can only specify a single metric in the sort parameter and the specified metric must be listed in the metric parameter of your request. Parameter names are case sensitive, but metric names are not. For example, the following are correct: sort=LISTING_IMPRESSION_TOTAL sort=lisitng_impression_total metric=lisitng_impression_total However, these are incorrect: SORT=LISTING_IMPRESSION_TOTAL SORT=lisitng_impression_total Metric=lisitng_impression_total For more information, see Traffic report details.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools