v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Bandwidth
Reporting

Get usage bandwidth report.

For given site it checks cloudflare stats for usage histogram.

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

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "result": {
    "totals": {
      "requests": {
        "count": 521
      },
      "usage": {
        "count": 521
      },
      "visits": {
        "count": 521
      }
    },
    "graph": {
      "requests": [
        {
          "count": 521,
          "ts": "2024-01-01T02:00:00Z"
        }
      ],
      "usage": [
        {
          "count": 521,
          "ts": "2024-01-01T02:00:00Z"
        }
      ],
      "visits": [
        {
          "count": 521,
          "ts": "2024-01-01T02:00:00Z"
        }
      ]
    }
  },
  "success": true,
  "errors": [],
  "messages": []
}