eBay

Analytics API

The Analytics API retrieves call-limit data and the quotas that are set for the RESTful APIs and the legacy Trading API. Responses from calls made to…

E-commerce#openapi#ecommerce

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Analytics API retrieves call-limit data and the quotas that are set for the RESTful APIs and the legacy Trading API. Responses from calls made to getRateLimits and getUerRateLimits include a list of the applicable resources and the "call limit", or quota, that is set for each resource. In addition to quota information, the response also includes the number of remaining calls available before the limit is reached, the time remaining before the quota resets, and the length of the "time window" to which the quota applies. The getRateLimits and getUserRateLimits methods retrieve call-limit information for either an application or user, respectively, and each method must be called with an appropriate OAuth token. That is, getRateLimites requires an access token generated with a client credentials grant and getUserRateLimites requires an access token generated with an authorization code grant. For more information, see OAuth tokens . Users can analyze the response data to see whether or not a limit might be reached, and from that determine if any action needs to be taken (such as programmatically throttling their request rate). For more on call limits, see Compatible Application Check .

Endpoints 2

rate_limit

  • GETgetRateLimits/rate_limit/?api_context=string&api_name=stringThis method retrieves the call limit and utilization data for an application. The data is retrieved for all RESTful APIs and the legacy Trading API.…

user_rate_limit

  • GETgetUserRateLimits/user_rate_limit/?api_context=string&api_name=stringThis method retrieves the call limit and utilization data for an application user. The call-limit data is returned for all RESTful APIs and the legacy Trading…

API details

Base URL
https://api.ebay.com{basePath}
Authentication
OAuth 2.0 (authorization code, client credentials flows) with 6 scopes
Operations
2 operations on 2 pathsGET 2
Main resources
rate_limit 1user_rate_limit 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version v1_beta.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Analytics API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Analytics API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code, client credentials flows) with 6 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “getRateLimits” (GET /rate_limit/?api_context=string&api_name=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Analytics API?

The Analytics API retrieves call-limit data and the quotas that are set for the RESTful APIs and the legacy Trading API. Responses from calls made to… It is listed under E-commerce and has 2 endpoints.

Who publishes the Analytics API?

It is listed from eBay's public API description (an OpenAPI document), not published by eBay on Swastik Codes. Anyone who controls ebay.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Analytics API?

Requests go to https://api.ebay.com{basePath}. Endpoint paths are added to this base URL.

How do I authenticate with the Analytics API?

With OAuth 2.0 (authorization code, client credentials flows) with 6 scopes.

How many endpoints does the Analytics API have?

2 operations on 2 paths (2 GET). The largest groups are rate_limit, user_rate_limit.

Is forking the Analytics API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.