{
"swagger": "2.0",
"info": {
"description": "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.",
"version": "v1_beta.0.0",
"title": "Analytics API",
"contact": {
"name": "eBay Inc."
},
"license": {
"name": "eBay API License Agreement",
"url": "https://go.developer.ebay.com/api-license-agreement"
}
},
"host": "api.ebay.com",
"basePath": "/developer/analytics/v1_beta",
"schemes": [
"https"
],
"paths": {
"/rate_limit/": {
"get": {
"tags": [
"rate_limit"
],
"description": "This method retrieves the call limit and utilization data for an application. The data is retrieved for all RESTful APIs and the legacy Trading API.
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 and the legacy Trading 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.",
"operationId": "getRateLimits",
"produces": [
"application/json"
],
"parameters": [
{
"name": "api_context",
"in": "query",
"description": "This optional query parameter filters the result to include only the specified API context.
Valid values:
buy
sell
commerce
developer
tradingapi
browse
for the Buy APIsinventory
for the Sell APIstaxonomy
for the Commerce APIstradingapi
for the Trading APIsbuy
sell
commerce
developer
tradingapi
browse
for the Buy APIsinventory
for the Sell APIstaxonomy
for the Commerce APIstradingapi
for the Trading APIs[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
2018-08-04T07:09:00.000Z
"
},
"timeWindow": {
"type": "integer",
"description": "A 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."
}
},
"description": "This complex type defines a \"rate\" as the quota of calls that can be made to a resource per time window, the remaining number of calls before the threshold is met, the amount of time until the time window resets, and the length of the time window (in seconds)."
},
"RateLimit": {
"type": "object",
"properties": {
"apiContext": {
"type": "string",
"description": "The context of the API for which rate-limit data is returned. For example buy
, sell
, commerce
, developer
or tradingapi
."
},
"apiName": {
"type": "string",
"description": "The name of the API for which rate-limit data is returned. For example browse
for the Buy API, inventory
for the Sell API, taxonomy
for the Commerce API, or tradingapi
for Trading API."
},
"apiVersion": {
"type": "string",
"description": "The version of the API for which rate-limit data is returned. For example v1
or v2
."
},
"resources": {
"type": "array",
"description": "A list of the methods for which rate-limit data is returned. For example item
for the Feed API, getOrder
for the Fulfillment API, getProduct
for the Catalog API, AddItems
for the Trading API.",
"items": {
"$ref": "#/definitions/Resource"
}
}
},
"description": "This complex types defines the resource (such as an API method) for which the rate-limit data is returned.