GetRevenueStatisticsRequest ¶

class GetRevenueStatisticsRequest(TypedDict, closed=True):
    statistic_type: "capo_wafv2.types.ranking_statistic_type.RankingStatisticType"
    """<p> <code>TOP_SOURCES_BY_REVENUE</code> ranks revenue from AI bot traffic, grouped by the dimension you specify in the <code>GroupBy</code> parameter (<code>NAME</code>, <code>CATEGORY</code>, <code>INTENT</code>, <code>ORGANIZATION</code>, or <code>WEBACL</code>); <code>GroupBy</code> is required for this statistic type. <code>TOP_PATHS_BY_REVENUE</code> ranks revenue by path.</p>"""
    time_window: "capo_wafv2.types.time_window.TimeWindow"
    """<p>The time range for the query. Specify start and end timestamps.</p>"""
    scope: "capo_wafv2.types.scope.Scope"
    """<p>Specifies whether this is for a Amazon CloudFront distribution (<code>CLOUDFRONT</code>) or for a regional application (<code>REGIONAL</code>).</p>"""
    currency: "capo_wafv2.types.currency.Currency"
    """<p>The currency for the revenue amounts in the response.</p>"""
    group_by: NotRequired["capo_wafv2.types.group_by_type.GroupByType"]
    """<p>The dimension to group results by: <code>NAME</code>, <code>CATEGORY</code>, <code>INTENT</code>, <code>ORGANIZATION</code>, or <code>WEBACL</code>. Required when <code>StatisticType</code> is <code>TOP_SOURCES_BY_REVENUE</code>. Not required for <code>TOP_PATHS_BY_REVENUE</code>, where results are grouped by content path. If <code>StatisticType</code> is <code>TOP_SOURCES_BY_REVENUE</code> and <code>GroupBy</code> is omitted, the request is rejected with a <code>WAFInvalidParameterException</code>.</p>"""
    filters: NotRequired[
        "capo_wafv2.types.monetization_filter_list.MonetizationFilterList"
    ]
    """<p>Optional filters to narrow the results.</p>"""
    next_marker: NotRequired["capo_wafv2.types.next_marker.NextMarker"]
    """<p>When you get a paginated response, this marker indicates that additional results are available. Use it in a subsequent request to retrieve the next page of results.</p>"""
    limit: NotRequired["capo_wafv2.types.path_statistics_limit.PathStatisticsLimit"]
    """<p>The maximum number of results to return.</p>"""
    sort_by: NotRequired["capo_wafv2.types.ranking_sort_by.RankingSortBy"]
    """<p>The field to sort results by: <code>REVENUE</code>, <code>PERCENTAGE</code>, or <code>NAME</code>.</p>"""
    sort_order: NotRequired["capo_wafv2.types.sort_order.SortOrder"]
    """<p>The sort order: <code>ASC</code> for ascending or <code>DESC</code> for descending.</p>"""