[ aws . wafv2 ]

get-revenue-statistics

Description

Retrieves ranked monetization statistics. Use the StatisticType parameter to specify the ranking: TOP_SOURCES_BY_REVENUE for top sources by revenue, or TOP_PATHS_BY_REVENUE for top content paths by revenue. 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

Synopsis

  get-revenue-statistics
--statistic-type <value>
--time-window <value>
--scope <value>
--currency <value>
[--group-by <value>]
[--filters <value>]
[--next-marker <value>]
[--limit <value>]
[--sort-by <value>]
[--sort-order <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--statistic-type (string) [required]

TOP_SOURCES_BY_REVENUE ranks revenue from AI bot traffic, grouped by the dimension you specify in the GroupBy parameter (NAME , CATEGORY , INTENT , ORGANIZATION , or WEBACL ); GroupBy is required for this statistic type. TOP_PATHS_BY_REVENUE ranks revenue by path.

Possible values:

• TOP_SOURCES_BY_REVENUE
• TOP_PATHS_BY_REVENUE

--time-window (structure) [required]

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

StartTime -> (timestamp) [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 -> (timestamp) [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.

Shorthand Syntax:

StartTime=timestamp,EndTime=timestamp

JSON Syntax:

{
  "StartTime": timestamp,
  "EndTime": timestamp
}

--scope (string) [required]

Specifies whether this is for a Amazon CloudFront distribution (CLOUDFRONT ) or for a regional application (REGIONAL ).

Possible values:

• CLOUDFRONT
• REGIONAL

--currency (string) [required]

The currency for the revenue amounts in the response.

Possible values:

• USDC

--group-by (string)

The dimension to group results by: NAME , CATEGORY , INTENT , ORGANIZATION , or WEBACL . Required when StatisticType is TOP_SOURCES_BY_REVENUE . Not required for TOP_PATHS_BY_REVENUE , where results are grouped by content path. If StatisticType is TOP_SOURCES_BY_REVENUE and GroupBy is omitted, the request is rejected with a WAFInvalidParameterException .

Possible values:

• NAME
• CATEGORY
• INTENT
• ORGANIZATION
• WEBACL

--filters (list)

Optional filters to narrow the results.

Constraints:

• min: 1
• max: 20

(structure)

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).

Constraints:

• min: 1
• max: 128

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.

Constraints:

• min: 1
• max: 20

(string)

Constraints:

• min: 1
• max: 256

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--next-marker (string)

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.

Constraints:

• min: 1
• max: 256
• pattern: .*\S.*

--limit (integer)

The maximum number of results to return.

Constraints:

• min: 1
• max: 100

--sort-by (string)

The field to sort results by: REVENUE , PERCENTAGE , or NAME .

Possible values:

• REVENUE
• PERCENTAGE
• NAME

--sort-order (string)

The sort order: ASC for ascending or DESC for descending.

Possible values:

• ASC
• DESC

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream
• off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

• legacy
• json
• yaml
• text
• table
• enhanced

Output

SourceStatistics -> (list)

Statistics for top revenue sources (AI bots). Populated when StatisticType is TOP_SOURCES_BY_REVENUE .

(structure)

Revenue statistics for a single AI bot source, including the bot name, revenue amount, request count, and verification status.

SourceName -> (string) [required]

The name of the AI bot.

Constraints:

• min: 1
• max: 256
• pattern: .*\S.*

Percentage -> (double) [required]

The percentage of total revenue from this source.

Constraints:

• min: 0.0
• max: 100.0

Amount -> (string) [required]

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

RequestCount -> (long) [required]

The number of monetized requests from this source.

Constraints:

• min: 0

SourceCategory -> (string)

The category of this AI bot source.

Constraints:

• min: 1
• max: 256
• pattern: .*\S.*

Intent -> (string)

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

Constraints:

• min: 1
• max: 256
• pattern: .*\S.*

Organization -> (string)

The organization associated with the AI bot.

Constraints:

• min: 1
• max: 256
• pattern: .*\S.*

Verified -> (boolean)

Whether the AI bot’s identity was verified.

GroupByValue -> (string)

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

Constraints:

• min: 1
• max: 256
• pattern: .*\S.*

RevenuePathStatistics -> (list)

Statistics for top revenue paths. Populated when StatisticType is TOP_PATHS_BY_REVENUE .

(structure)

Revenue statistics for a single content path, including the path, revenue amount, and request count.

Path -> (string) [required]

The URI path.

Constraints:

• min: 1
• max: 512

Percentage -> (double) [required]

The percentage of total revenue from this path.

Constraints:

• min: 0.0
• max: 100.0

Amount -> (string) [required]

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

RequestCount -> (long) [required]

The number of monetized requests to this path.

Constraints:

• min: 0

NextMarker -> (string)

When you get a paginated response, this marker indicates that additional results are available.

Constraints:

• min: 1
• max: 256
• pattern: .*\S.*