Skip to content

PathStatistics

Source code in docs_src/capo_wafv2/types/path_statistics.py 
17
18
19
20
21
22
23
24
25
26
27
class PathStatistics(TypedDict, closed=True):
    source: NotRequired["capo_wafv2.types.filter_source.FilterSource"]
    """<p>Information about the bot filter that was applied to generate these statistics. This field is only populated when you filter by bot category, organization, or name.</p>"""
    path: "capo_wafv2.types.path_string.PathString"
    """<p>The URI path. For example, <code>/api/</code> or <code>/api/v1/users</code>.</p>"""
    request_count: "capo_wafv2.types.request_count.RequestCount"
    """<p>The number of requests to this path within the specified time window.</p>"""
    percentage: "capo_wafv2.types.percentage_value.PercentageValue"
    """<p>The percentage of total requests that were made to this path.</p>"""
    top_bots: NotRequired["capo_wafv2.types.bot_statistics_list.BotStatisticsList"]
    """<p>The list of top bots accessing this path, ordered by request count. The number of bots included is determined by the <code>NumberOfTopTrafficBotsPerPath</code> parameter in the request.</p>"""

path instance-attribute 

path: PathString

The URI path. For example, /api/ or /api/v1/users.

percentage instance-attribute 

percentage: PercentageValue

The percentage of total requests that were made to this path.

request_count instance-attribute 

request_count: RequestCount

The number of requests to this path within the specified time window.

source instance-attribute 

source: NotRequired[FilterSource]

Information about the bot filter that was applied to generate these statistics. This field is only populated when you filter by bot category, organization, or name.

top_bots instance-attribute 

top_bots: NotRequired[BotStatisticsList]

The list of top bots accessing this path, ordered by request count. The number of bots included is determined by the NumberOfTopTrafficBotsPerPath parameter in the request.