WAFV2 / Client / get_revenue_statistics_summary

get_revenue_statistics_summary

WAFV2.Client.get_revenue_statistics_summary(**kwargs)

Retrieves a summary of monetization revenue for the specified time window. Returns total revenue, revenue by verification tier, total settlements, and total HTTP 402 responses served. This operation is only available for CLOUDFRONT scope. The maximum supported time window is 90 days. When no CurrencyMode filter is provided, results default to REAL. To retrieve test data, include a CurrencyMode filter with the value TEST.

See also: AWS API Documentation

Request Syntax

response = client.get_revenue_statistics_summary(
    TimeWindow={
        'StartTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1)
    },
    Scope='CLOUDFRONT'|'REGIONAL',
    Currency='USDC',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)
Parameters:

  • TimeWindow (dict) –

    [REQUIRED]

    The time range for the revenue summary query. Specify start and end timestamps.

    • StartTime (datetime) – [REQUIRED]

      The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

    • EndTime (datetime) – [REQUIRED]

      The end of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

  • Scope (string) –

    [REQUIRED]

    Specifies whether this is for a Amazon CloudFront distribution ( CLOUDFRONT) or for a regional application ( REGIONAL). AI bot monetization is only available for CLOUDFRONT scope.

  • Currency (string) –

    [REQUIRED]

    The currency for the revenue amounts in the response. Currently only USDC is supported.

  • Filters (list) –

    Optional filters to narrow the results. You can filter by source name, category, organization, intent, verified status, content path, web ACL ARN, or currency mode.

    • (dict) –

      A filter for narrowing monetization statistics and settlement record results. Specify a filter name and one or more values to match.

      Filter behavior:

      • Multiple values within one filter: OR (match any)

      • Multiple filters: AND (all must match)

      • No duplicate filter names allowed (rejected with error)

      • Duplicate values within a filter are silently deduplicated

      • If no CurrencyMode filter is specified, defaults to REAL

      • Name (string) – [REQUIRED]

        The filter name. Format: Key is a string, Value is a list of strings.

        Enum-restricted (invalid values rejected):

        • CurrencyMode: REAL, TEST

        • ChainName: BASE, SOLANA, BASE_SEPOLIA, SOLANA_DEVNET

        • SettlementStatus: SETTLED, PENDING, FAILED, SERVICE_ERROR, SKIPPED_ORIGIN_ERROR, DUPLICATE

        • HttpSourceName: CF, ALB, APIGW, APPRUNNER, COGNITO, VERIFIED_ACCESS

        ARN-validated:

        • WebACLArn: valid WAFv2 web ACL ARN

        Free-text (any string up to 256 chars):

        • SourceName: The name of the bot. Populated from Bot Control verified bot labels.

        • SourceCategory: The category classification of the bot. From Bot Control categorization.

        • Intent: The declared intent of the bot request.

        • Organization: The organization operating the bot.

        • UriPathPrefix: The URI path of the request that was monetized.

        • RequestId: The WAF request ID associated with the transaction. Matches the requestId in WAF logs. Pattern: ^[a-zA-Z0-9:._\-=+/]+$

        • TransactionId: The blockchain transaction identifier. Pattern: ^[a-zA-Z0-9:._\-=+/]+$

        • TerminatingRuleName: The name of the WAF rule that triggered the Monetize action.

        • PayerAddress: The blockchain wallet address of the paying client. Pattern: ^[a-zA-Z0-9:._\-=+/]+$

        • HttpSourceId: The identifier of the Amazon Web Services resource associated with the web ACL (for example, CloudFront distribution ID).

      • Values (list) – [REQUIRED]

        The values to filter on. Specify as a list of strings. Results match any of the specified values (OR logic). Duplicate values are silently deduplicated. Maximum: 20 values per filter.

        • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'RevenueBreakdown': {
        'TotalAmount': 'string',
        'VerifiedAmount': 'string',
        'UnverifiedAmount': 'string',
        'Currency': 'USDC',
        'TotalSettled': 123,
        'TotalMonetizeServed': 123
    }
}

Response Structure

  • (dict) –

    • RevenueBreakdown (dict) –

      The revenue breakdown summary for the specified time window and filters.

      • TotalAmount (string) –

        The total revenue amount in the specified currency.

      • VerifiedAmount (string) –

        The revenue amount from verified AI bots.

      • UnverifiedAmount (string) –

        The revenue amount from unverified AI bots.

      • Currency (string) –

        The currency of the revenue amounts.

      • TotalSettled (integer) –

        The total number of successfully settled payment transactions.

      • TotalMonetizeServed (integer) –

        The total number of HTTP 402 Payment Required responses served to AI agents.

Exceptions