Skip to content

SourceStatistics

Source code in docs_src/capo_wafv2/types/source_statistics.py
class SourceStatistics(TypedDict, closed=True):
    source_name: "capo_wafv2.types.filter_string.FilterString"
    """<p>The name of the AI bot.</p>"""
    percentage: "capo_wafv2.types.percentage_value.PercentageValue"
    """<p>The percentage of total revenue from this source.</p>"""
    amount: "capo_wafv2.types.monetization_amount_value.MonetizationAmountValue"
    """<p>The total revenue amount from this source in the specified currency.</p>"""
    request_count: "capo_wafv2.types.request_count.RequestCount"
    """<p>The number of monetized requests from this source.</p>"""
    source_category: NotRequired["capo_wafv2.types.filter_string.FilterString"]
    """<p>The category of this AI bot source.</p>"""
    intent: NotRequired["capo_wafv2.types.filter_string.FilterString"]
    """<p>The declared intent of the AI bot (for example, summarize, index, or train).</p>"""
    organization: NotRequired["capo_wafv2.types.filter_string.FilterString"]
    """<p>The organization associated with the AI bot.</p>"""
    verified: "capo_wafv2.types.verified_status.VerifiedStatus"
    """<p>Indicates whether the AI bot's identity was verified — for example, through a cryptographically signed request (Web Bot Auth) or another published verification method. This value is meaningful only when GroupBy is NAME, where each result represents a single, identifiable bot. For all other GroupBy values (CATEGORY, INTENT, ORGANIZATION, or WEBACL), a result aggregates multiple bots that may have different verification states, so Verified is always returned as false and should be ignored. Type and required-ness are unchanged (Boolean, optional).</p>"""
    group_by_value: NotRequired["capo_wafv2.types.filter_string.FilterString"]
    """<p>The value for the group-by dimension, when grouping is applied.</p>"""

amount instance-attribute

The total revenue amount from this source in the specified currency.

group_by_value instance-attribute

group_by_value: NotRequired[FilterString]

The value for the group-by dimension, when grouping is applied.

intent instance-attribute

intent: NotRequired[FilterString]

The declared intent of the AI bot (for example, summarize, index, or train).

organization instance-attribute

organization: NotRequired[FilterString]

The organization associated with the AI bot.

percentage instance-attribute

percentage: PercentageValue

The percentage of total revenue from this source.

request_count instance-attribute

request_count: RequestCount

The number of monetized requests from this source.

source_category instance-attribute

source_category: NotRequired[FilterString]

The category of this AI bot source.

source_name instance-attribute

source_name: FilterString

The name of the AI bot.

verified instance-attribute

verified: VerifiedStatus

Indicates whether the AI bot's identity was verified — for example, through a cryptographically signed request (Web Bot Auth) or another published verification method. This value is meaningful only when GroupBy is NAME, where each result represents a single, identifiable bot. For all other GroupBy values (CATEGORY, INTENT, ORGANIZATION, or WEBACL), a result aggregates multiple bots that may have different verification states, so Verified is always returned as false and should be ignored. Type and required-ness are unchanged (Boolean, optional).