v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB

Reporting

Get usage bandwidth report.

For given site it checks cloudflare stats for usage histogram.

get/v1/reporting/sites/{id}/bandwidth/usage

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Query parameters

duration'30m' | '1h' | '6h' | '12h' | '24h' | '72h' | '7d' | '30d' required

Duration that the listed data is for (m = minutes, h = hours, d = days)

Example:7d

Response

successboolean

whether the request succeeded

errorsstring[]

Example response

{
  "data": {
    "viewer": {
      "__typename": "viewer",
      "zones": [
        {
          "__typename": "zone",
          "series": [
            {
              "__typename": "ZoneHttpRequestsAdaptiveGroups",
              "avg": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsAvg",
                "sampleInterval": 3.8457300275482096
              },
              "count": 456888,
              "dimensions": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsDimensions",
                "ts": "2024-01-01T02:00:00Z"
              },
              "sum": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsSum",
                "edgeResponseBytes": 3378484777
              }
            }
          ]
        }
      ]
    }
  },
  "success": true,
  "errors": [
    "bf095f43-72a7-45cc-b4c3-cfbace9695cb"
  ]
}