Analytics API — client.developer.analytics¶
Version v1_beta.0.1 · base path /developer/analytics/v1_beta · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
get_rate_limits ¶
get_rate_limits(*, api_name: str | None = None, api_context: Literal['buy', 'sell', 'commerce', 'developer', 'tradingapi'] | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> developer_analytics_models.RateLimitsResponse
get_rate_limits(*, api_name: str | None = None, api_context: Literal['buy', 'sell', 'commerce', 'developer', 'tradingapi'] | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_rate_limits(*, api_name: str | None = None, api_context: Literal['buy', 'sell', 'commerce', 'developer', 'tradingapi'] | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> developer_analytics_models.RateLimitsResponse | httpx.Response
Retrieves call limit and utilization data for an application based on search criteria.
get_user_rate_limits ¶
get_user_rate_limits(*, api_name: str | None = None, api_context: Literal['buy', 'sell', 'commerce', 'developer', 'tradingapi'] | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> developer_analytics_models.RateLimitsResponse
get_user_rate_limits(*, api_name: str | None = None, api_context: Literal['buy', 'sell', 'commerce', 'developer', 'tradingapi'] | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_user_rate_limits(*, api_name: str | None = None, api_context: Literal['buy', 'sell', 'commerce', 'developer', 'tradingapi'] | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> developer_analytics_models.RateLimitsResponse | httpx.Response
Retrieves call limit and utilization data for a user based on search criteria.
Models¶
ErrorParameter ¶
Rate ¶
Bases: EbayModel
count
class-attribute
instance-attribute
¶
count = Field(None, description='The number of calls a user has made to this resource within a set time period. This time period is defined by the associated timeWindow value.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The 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.')
remaining
class-attribute
instance-attribute
¶
remaining = Field(None, description='The remaining number of requests that can be made to this resource before the associated time window resets.')
reset
class-attribute
instance-attribute
¶
reset = Field(None, description='The 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.')
time_window
class-attribute
instance-attribute
¶
time_window = Field(None, alias='timeWindow', 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.')
Resource ¶
Bases: EbayModel
name
class-attribute
instance-attribute
¶
name = Field(None, description='The name of the resource (an API or an API method) to which the rate-limit data applies.')
rates
class-attribute
instance-attribute
¶
rates = Field(None, description='A list of rate-limit data, where each list element represents the rate-limit data for a specific resource.')
Error ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description='Identifies the type of error.')
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='Name for the primary system where the error occurred. This is relevant for application errors.')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', description='A unique number to identify the error.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description='An array of request elements most closely associated to the error.')
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='A more detailed explanation of the error.')
message
class-attribute
instance-attribute
¶
message = Field(None, description="Information on how to correct the problem, in the end user's terms and language where applicable.")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='An array of request elements most closely associated to the error.')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description='Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.')
RateLimit ¶
Bases: EbayModel
api_context
class-attribute
instance-attribute
¶
api_context = Field(None, alias='apiContext', description='The context of the API for which rate-limit data is returned. For example buy , sell , commerce , developer or tradingapi .')
api_name
class-attribute
instance-attribute
¶
api_name = Field(None, alias='apiName', 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.')
api_version
class-attribute
instance-attribute
¶
api_version = Field(None, alias='apiVersion', description='The version of the API for which rate-limit data is returned. For example v1 or v2 .')
resources
class-attribute
instance-attribute
¶
resources = Field(None, 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.')
RateLimitsResponse ¶
Bases: EbayModel
rate_limits
class-attribute
instance-attribute
¶
rate_limits = Field(None, alias='rateLimits', description='The 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.')