Sign in

v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
CDN Statistics

Aggregated origin shielding usage statistics

The number of CDN resources that use origin shielding.

Request URL parameters should be added as a query string after the endpoint.

get/cdn/statistics/shield_usage/aggregated

Query parameters

fromstring required

Beginning of the requested time period (ISO 8601/RFC 3339 format, UTC.)

tostring required

End of the requested time period (ISO 8601/RFC 3339 format, UTC.)

group_bystring

Output data grouping.

Possible value:

  • resource - Data is grouped by CDN resources.
resourceinteger

CDN resources IDs by that statistics data is grouped.

To request multiple values, use:

  • &resource=1&resource=2

If CDN resource ID is not specified, data related to all CDN resources is returned.

flatboolean

The way the parameters are arranged in the response.

Possible values:

  • true – Flat structure is used.
  • false – Embedded structure is used (default.)

Response

Successful.

resourceobject

Resources IDs by which statistics data is grouped.

1 (example)object

CDN resource ID for which statistics data is shown.

metricsobject

Statistics parameters.

shield_usagestring

Number of CDN resources that used origin shielding.

Example response

{
  "resource": {
    "1": {
      "metrics": {
        "shield_usage": 1
      }
    }
  }
}