Skip to content

Usage

Source code in docs_src/capo_api_gateway/types/usage.py 
12
13
14
15
16
17
18
19
20
21
22
class Usage(TypedDict, closed=True):
    usage_plan_id: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The plan Id associated with this usage data.</p>"""
    start_date: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The starting date of the usage data.</p>"""
    end_date: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The ending date of the usage data.</p>"""
    items: NotRequired["capo_api_gateway.types.map_of_key_usages.MapOfKeyUsages"]
    """<p>The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, <code>{..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}</code>, where <code>{api_key}</code> stands for an API key value and the daily log entry is of the format <code>[used quota, remaining quota]</code>.</p>"""
    position: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The current pagination position in the paged result set.</p>"""

end_date instance-attribute 

end_date: NotRequired[String]

The ending date of the usage data.

items instance-attribute 

items: NotRequired[MapOfKeyUsages]

The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

position instance-attribute 

position: NotRequired[String]

The current pagination position in the paged result set.

start_date instance-attribute 

start_date: NotRequired[String]

The starting date of the usage data.

usage_plan_id instance-attribute 

usage_plan_id: NotRequired[String]

The plan Id associated with this usage data.