Skip to content

Retrieves a summary of monetization revenue for the specified time window

Description

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.

Usage

wafv2_get_revenue_statistics_summary(TimeWindow, Scope, Currency,
  Filters)

Arguments

  • TimeWindow

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

  • Scope

[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

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

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

Value

A list with the following syntax:

list(
  RevenueBreakdown = list(
    TotalAmount = "string",
    VerifiedAmount = "string",
    UnverifiedAmount = "string",
    Currency = "USDC",
    TotalSettled = 123,
    TotalMonetizeServed = 123
  )
)

Request syntax

svc$get_revenue_statistics_summary(
  TimeWindow = list(
    StartTime = as.POSIXct(
      "2015-01-01"
    ),
    EndTime = as.POSIXct(
      "2015-01-01"
    )
  ),
  Scope = "CLOUDFRONT"|"REGIONAL",
  Currency = "USDC",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  )
)