analytics APIv1_beta.0.0

getRateLimits

GET
/rate_limit/
This method retrieves the call limit and utilization data for an application. The data is retrieved for all RESTful APIs and resources.

The response from getRateLimits includes 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.

By default, this method returns utilization data for all RESTful API resources. Use the api_name and api_context query parameters to filter the response to only the desired APIs.

For more on call limits, see Compatible Application Check.

Input

Resource URI (production)

GET https://api.ebay.com/developer/analytics/v1_beta/rate_limit/?

URI parameters

ParameterTypeDescription
api_contextstringThis optional query parameter filters the result to include only the specified API context. Acceptable values for the parameter are buy, sell, commerce, and developer.

Occurrence: Optional

api_namestringThis optional query parameter filters the result to include only the APIs specified. Example values are browse for the Buy APIs context, inventory for the Sell APIs context, and taxonomy for the Commerce APIs context.

Occurrence: Optional

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

OAuth scope

This request requires an access token created with the client credentials grant flow, using one scope from the following list:

https://api.ebay.com/oauth/api_scope

See OAuth access tokens for more information.

Output

HTTP response headers

{ /* RateLimitsResponse */
"rateLimits" : [
{ /* RateLimit */
"resources" : [
{ /* Resource */
"name" : "string",
"rates" : [
{ /* Rate */
"limit" : "integer",
"reset" : "string",
}
]
}
]
}
]
}
Output container/fieldTypeDescription
rateLimitsarray of RateLimitThe rate-limit data for the specified APIs. The rate-limit data is returned for all the methods in the specified APIs and data pertains to the current time window.

Occurrence: Conditional

rateLimits.apiContextstringThe context of the API for which rate-limit data is returned. For example buy, sell, commerce, or developer.

Occurrence: Conditional

rateLimits.apiNamestringThe name of the API for which rate-limit data is returned. For example browse for the Buy API, inventory for the Sell API, or taxonomy for the Commerce API.

Occurrence: Conditional

rateLimits.apiVersionstringThe version of the API for which rate-limit data is returned. For example v1 or v2.

Occurrence: Conditional

rateLimits.resourcesarray of ResourceA list of the methods for which rate-limit data is returned. For example item for the Feed API, getOrder for the Fulfillment API, and getProduct for the Catalog API.

Occurrence: Conditional

rateLimits.resources.namestringThe name of the resource (an API or an API method) to which the rate-limit data applies.

Occurrence: Conditional

rateLimits.resources.ratesarray of RateA list of rate-limit data, where each list element represents the rate-limit data for a specific resource.

Occurrence: Conditional

rateLimits.resources.rates.limitintegerThe maximum number of requests that can be made to this resource during a set time period. The length of time to which the limit is applied is defined by the associated timeWindow value.

This value is often referred to as the "call quota" for the resource.

Occurrence: Conditional

rateLimits.resources.rates.remainingintegerThe remaining number of requests that can be made to this resource before the associated time window resets.

Occurrence: Conditional

rateLimits.resources.rates.resetstringThe data and time the time window and accumulated calls for this resource reset.

When the reset time is reached, the remaining value is reset to the value of limit, and this reset value is reset to the current time plus the number of seconds defined by the timeWindow value.

The time stamp is formatted as an ISO 8601 string, which is based on the 24-hour Universal Coordinated Time (UTC) clock.

Format: YYYY-MM-DDTHH:MM:SS.SSSZ
Example: 2018-08-04T07:09:00.000Z

Occurrence: Conditional

rateLimits.resources.rates.timeWindowintegerA period of time, expressed in seconds. The call quota for a resource is applied to the period of time defined by the value of this field.

Occurrence: Conditional

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
200OK
204No Content
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
105000API_ANALYTICSAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Get the call-limit data for an application

This example shows call how to retrieve the call-limit data for all resources available to an application.

Input

This method does not use a request body. However, you can use the api_name and api_context query parameters to control the data returned in the response.
GET
https://api.ebay.com/developer/analytics/v1_beta/rate_limit/

Output

A successful request for a call that does not specify any query parameters returns a list of call-limit data for all the supported resources.