Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetRevenueStatisticsSummary

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.

Request Syntax


{
   "Currency": "string",
   "Filters": [ 
      { 
         "Name": "string",
         "Values": [ "string" ]
      }
   ],
   "Scope": "string",
   "TimeWindow": { 
      "EndTime": number,
      "StartTime": number
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Currency

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

Type: String

Valid Values: USDC

Required: Yes

Filters

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.

Type: Array of MonetizationFilter objects

Array Members: Minimum number of 1 item. Maximum number of 20 items.

Required: No

Scope

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.

Type: String

Valid Values: CLOUDFRONT | REGIONAL

Required: Yes

TimeWindow

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

Type: TimeWindow object

Required: Yes

Response Syntax


{
   "RevenueBreakdown": { 
      "Currency": "string",
      "TotalAmount": "string",
      "TotalMonetizeServed": number,
      "TotalSettled": number,
      "UnverifiedAmount": "string",
      "VerifiedAmount": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

RevenueBreakdown

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

Type: RevenueBreakdown object

Errors

For information about the errors that are common to all actions, see Common Error Types.

WAFInternalErrorException

Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request.

HTTP Status Code: 500

WAFInvalidOperationException

The operation isn't valid.

HTTP Status Code: 400

WAFInvalidParameterException

The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

Field: The settings where the invalid parameter was found.
Parameter: The invalid parameter that resulted in the exception.
Reason: Additional information about the exception.

HTTP Status Code: 400

WAFNonexistentItemException

AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

HTTP Status Code: 400