Retrieves time series data for monetization revenue¶

Description¶

Retrieves time series data for monetization revenue. Returns data points aggregated at the specified interval for the given time window. 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_time_series(StatisticType, TimeWindow,
  Scope, Interval, Currency, GroupBy, Filters, Limit, NextMarker)

Arguments¶

• StatisticType

[required] The type of time series data to retrieve: DATE_HISTOGRAM for revenue over time, or PAYMENT_TRAFFIC for payment traffic patterns.

• TimeWindow

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

• Scope

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

• Interval

[required] The time interval for aggregating data points: MINUTELY, FIVE_MINUTELY, HOURLY, or DAILY.

• Currency

[required] The currency for the amounts in the response.

• GroupBy

The dimension to group results by.

• Filters

Optional filters to narrow the results.

• Limit

The maximum number of data points to return. Minimum: 1. Maximum: 10000.

• NextMarker

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

Value¶

A list with the following syntax:

list(
  DataPoints = list(
    list(
      Date = as.POSIXct(
        "2015-01-01"
      ),
      MonetizeServedCount = 123,
      SettledCount = 123,
      TotalAmount = "string",
      Category = "string",
      Intent = "string",
      GroupByValue = "string"
    )
  ),
  NextMarker = "string"
)

Request syntax¶

svc$get_revenue_statistics_time_series(
  StatisticType = "DATE_HISTOGRAM"|"PAYMENT_TRAFFIC",
  TimeWindow = list(
    StartTime = as.POSIXct(
      "2015-01-01"
    ),
    EndTime = as.POSIXct(
      "2015-01-01"
    )
  ),
  Scope = "CLOUDFRONT"|"REGIONAL",
  Interval = "MINUTELY"|"FIVE_MINUTELY"|"HOURLY"|"DAILY",
  Currency = "USDC",
  GroupBy = "NAME"|"CATEGORY"|"INTENT"|"ORGANIZATION"|"WEBACL",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  Limit = 123,
  NextMarker = "string"
)