v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Reporting

Get top usage bandwidth report.

For given site it checks cloudflare stats for bandwidth top users.

get/v1/reporting/sites/{id}/bandwidth/top-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

OK

successboolean

whether the request succeeded

errorsstring[]

Example response

{
  "data": {
    "viewer": {
      "__typename": "viewer",
      "zones": [
        {
          "__typename": "zone",
          "countries": [
            {
              "__typename": "ZoneHttpRequestsAdaptiveGroups",
              "avg": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsAvg",
                "sampleInterval": 3.8457300275482096
              },
              "count": 456888,
              "dimensions": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsDimensions",
                "metric": "100016",
                "ts": "2024-08-19T20:05:00Z"
              },
              "sum": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsSum",
                "edgeResponseBytes": 3378484777
              }
            }
          ],
          "methods": [
            {
              "__typename": "ZoneHttpRequestsAdaptiveGroups",
              "avg": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsAvg",
                "sampleInterval": 3.8457300275482096
              },
              "count": 456888,
              "dimensions": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsDimensions",
                "metric": "100016",
                "ts": "2024-08-19T20:05:00Z"
              },
              "sum": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsSum",
                "edgeResponseBytes": 3378484777
              }
            }
          ],
          "topASNs": [
            {
              "__typename": "ZoneHttpRequestsAdaptiveGroups",
              "avg": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsAvg",
                "sampleInterval": 3.8457300275482096
              },
              "count": 456888,
              "dimensions": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsDimensions",
                "description": "AMAZON-AES",
                "metric": "100016",
                "ts": "2024-08-19T20:05:00Z"
              },
              "sum": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsSum",
                "edgeResponseBytes": 3378484777
              }
            }
          ],
          "topBrowsers": [
            {
              "__typename": "ZoneHttpRequestsAdaptiveGroups",
              "avg": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsAvg",
                "sampleInterval": 3.8457300275482096
              },
              "count": 456888,
              "dimensions": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsDimensions",
                "metric": "100016",
                "ts": "2024-08-19T20:05:00Z"
              },
              "sum": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsSum",
                "edgeResponseBytes": 3378484777
              }
            }
          ],
          "topCacheStatuses": [
            {
              "__typename": "ZoneHttpRequestsAdaptiveGroups",
              "avg": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsAvg",
                "sampleInterval": 3.8457300275482096
              },
              "count": 456888,
              "dimensions": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsDimensions",
                "metric": "100016",
                "ts": "2024-08-19T20:05:00Z"
              },
              "sum": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsSum",
                "edgeResponseBytes": 3378484777
              }
            }
          ],
          "topClientIPs": [
            {
              "__typename": "ZoneHttpRequestsAdaptiveGroups",
              "avg": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsAvg",
                "sampleInterval": 3.8457300275482096
              },
              "count": 456888,
              "dimensions": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsDimensions",
                "metric": "100016",
                "ts": "2024-08-19T20:05:00Z"
              },
              "sum": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsSum",
                "edgeResponseBytes": 3378484777
              }
            }
          ],
          "topColoCodes": [
            {
              "__typename": "ZoneHttpRequestsAdaptiveGroups",
              "avg": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsAvg",
                "sampleInterval": 3.8457300275482096
              },
              "count": 456888,
              "dimensions": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsDimensions",
                "metric": "100016",
                "ts": "2024-08-19T20:05:00Z"
              },
              "sum": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsSum",
                "edgeResponseBytes": 3378484777
              }
            }
          ],
          "topDeviceTypes": [
            {
              "__typename": "ZoneHttpRequestsAdaptiveGroups",
              "avg": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsAvg",
                "sampleInterval": 3.8457300275482096
              },
              "count": 456888,
              "dimensions": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsDimensions",
                "metric": "100016",
                "ts": "2024-08-19T20:05:00Z"
              },
              "sum": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsSum",
                "edgeResponseBytes": 3378484777
              }
            }
          ],
          "topEdgeStatusCodes": [
            {
              "__typename": "ZoneHttpRequestsAdaptiveGroups",
              "avg": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsAvg",
                "sampleInterval": 3.8457300275482096
              },
              "count": 456888,
              "dimensions": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsDimensions",
                "metric": 404
              },
              "sum": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsSum",
                "edgeResponseBytes": 3378484777
              }
            }
          ],
          "topHTTPProtocolVersions": [
            {
              "__typename": "ZoneHttpRequestsAdaptiveGroups",
              "avg": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsAvg",
                "sampleInterval": 3.8457300275482096
              },
              "count": 456888,
              "dimensions": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsDimensions",
                "metric": "100016",
                "ts": "2024-08-19T20:05:00Z"
              },
              "sum": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsSum",
                "edgeResponseBytes": 3378484777
              }
            }
          ],
          "topHosts": [
            {
              "__typename": "ZoneHttpRequestsAdaptiveGroups",
              "avg": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsAvg",
                "sampleInterval": 3.8457300275482096
              },
              "count": 456888,
              "dimensions": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsDimensions",
                "metric": "100016",
                "ts": "2024-08-19T20:05:00Z"
              },
              "sum": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsSum",
                "edgeResponseBytes": 3378484777
              }
            }
          ],
          "topOSs": [
            {
              "__typename": "ZoneHttpRequestsAdaptiveGroups",
              "avg": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsAvg",
                "sampleInterval": 3.8457300275482096
              },
              "count": 456888,
              "dimensions": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsDimensions",
                "metric": "100016",
                "ts": "2024-08-19T20:05:00Z"
              },
              "sum": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsSum",
                "edgeResponseBytes": 3378484777
              }
            }
          ],
          "topOriginStatusCodes": [
            {
              "__typename": "ZoneHttpRequestsAdaptiveGroups",
              "avg": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsAvg",
                "sampleInterval": 3.8457300275482096
              },
              "count": 456888,
              "dimensions": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsDimensions",
                "metric": 404
              },
              "sum": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsSum",
                "edgeResponseBytes": 3378484777
              }
            }
          ],
          "topPaths": [
            {
              "__typename": "ZoneHttpRequestsAdaptiveGroups",
              "avg": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsAvg",
                "sampleInterval": 3.8457300275482096
              },
              "count": 456888,
              "dimensions": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsDimensions",
                "metric": "100016",
                "ts": "2024-08-19T20:05:00Z"
              },
              "sum": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsSum",
                "edgeResponseBytes": 3378484777
              }
            }
          ],
          "topReferers": [
            {
              "__typename": "ZoneHttpRequestsAdaptiveGroups",
              "avg": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsAvg",
                "sampleInterval": 3.8457300275482096
              },
              "count": 456888,
              "dimensions": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsDimensions",
                "metric": "100016",
                "ts": "2024-08-19T20:05:00Z"
              },
              "sum": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsSum",
                "edgeResponseBytes": 3378484777
              }
            }
          ],
          "topUserAgents": [
            {
              "__typename": "ZoneHttpRequestsAdaptiveGroups",
              "avg": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsAvg",
                "sampleInterval": 3.8457300275482096
              },
              "count": 456888,
              "dimensions": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsDimensions",
                "metric": "100016",
                "ts": "2024-08-19T20:05:00Z"
              },
              "sum": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsSum",
                "edgeResponseBytes": 3378484777
              }
            }
          ],
          "topXRequestedWith": [
            {
              "__typename": "ZoneHttpRequestsAdaptiveGroups",
              "avg": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsAvg",
                "sampleInterval": 3.8457300275482096
              },
              "count": 456888,
              "dimensions": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsDimensions",
                "metric": "100016",
                "ts": "2024-08-19T20:05:00Z"
              },
              "sum": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsSum",
                "edgeResponseBytes": 3378484777
              }
            }
          ],
          "total": [
            {
              "__typename": "ZoneHttpRequestsAdaptiveGroups",
              "count": 456888,
              "sum": {
                "__typename": "ZoneHttpRequestsAdaptiveGroupsSum",
                "edgeResponseBytes": 3378484777,
                "visits": 15
              }
            }
          ]
        }
      ]
    }
  },
  "success": true,
  "errors": [
    "bf095f43-72a7-45cc-b4c3-cfbace9695cb"
  ]
}