Get Bot Classes Time Series

Get a time series of the percentage distribution of traffic classified as automated or human. Visit https://developers.cloudflare.com/radar/concepts/bot-classes/ for more information.

/radar/http/timeseries_groups/bot_class

get

Radar Http

radar-get-http-timeseries-group-by-bot-class

Debug "planAvailability"

{
  "business": true,
  "enterprise": true,
  "free": true,
  "pro": true
}

Debug "tokenPermissions"

{
  "enum": [
    "com.cloudflare.api.user.read"
  ]
}

Debug "parameters"

[
  {
    "in": "query",
    "name": "aggInterval",
    "schema": {
      "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).",
      "enum": [
        "15m",
        "1h",
        "1d",
        "1w"
      ],
      "example": "1h",
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "name",
    "schema": {
      "description": "Array of names that will be used to name the series in responses.",
      "example": "main_series",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  {
    "in": "query",
    "name": "dateRange",
    "schema": {
      "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).",
      "items": {
        "enum": [
          "1d",
          "2d",
          "7d",
          "14d",
          "28d",
          "12w",
          "24w",
          "52w",
          "1dControl",
          "2dControl",
          "7dControl",
          "14dControl",
          "28dControl",
          "12wControl",
          "24wControl"
        ],
        "type": "string"
      },
      "type": "array"
    }
  },
  {
    "in": "query",
    "name": "dateStart",
    "schema": {
      "description": "Array of datetimes to filter the start of a series.",
      "example": "2023-09-01T11:41:33.782Z",
      "items": {
        "format": "date-time",
        "type": "string"
      },
      "type": "array"
    }
  },
  {
    "in": "query",
    "name": "dateEnd",
    "schema": {
      "description": "End of the date range (inclusive).",
      "example": "2023-09-01T11:41:33.782Z",
      "items": {
        "format": "date-time",
        "type": "string"
      },
      "type": "array"
    }
  },
  {
    "in": "query",
    "name": "asn",
    "schema": {
      "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.",
      "example": "15169",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  {
    "in": "query",
    "name": "location",
    "schema": {
      "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.",
      "example": "US,CA",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  {
    "in": "query",
    "name": "deviceType",
    "schema": {
      "description": "Filter for device type.",
      "example": "DESKTOP",
      "items": {
        "enum": [
          "DESKTOP",
          "MOBILE",
          "OTHER"
        ],
        "type": "string"
      },
      "type": "array"
    }
  },
  {
    "in": "query",
    "name": "httpProtocol",
    "schema": {
      "description": "Filter for http protocol.",
      "example": "HTTPS",
      "items": {
        "enum": [
          "HTTP",
          "HTTPS"
        ],
        "type": "string"
      },
      "type": "array"
    }
  },
  {
    "in": "query",
    "name": "httpVersion",
    "schema": {
      "description": "Filter for http version.",
      "example": "HTTPv1",
      "items": {
        "enum": [
          "HTTPv1",
          "HTTPv2",
          "HTTPv3"
        ],
        "type": "string"
      },
      "type": "array"
    }
  },
  {
    "in": "query",
    "name": "ipVersion",
    "schema": {
      "description": "Filter for ip version.",
      "example": "IPv4",
      "items": {
        "enum": [
          "IPv4",
          "IPv6"
        ],
        "type": "string"
      },
      "type": "array"
    }
  },
  {
    "in": "query",
    "name": "os",
    "schema": {
      "description": "Filter for os name.",
      "example": "WINDOWS",
      "items": {
        "enum": [
          "WINDOWS",
          "MACOSX",
          "IOS",
          "ANDROID",
          "CHROMEOS",
          "LINUX",
          "SMART_TV"
        ],
        "type": "string"
      },
      "type": "array"
    }
  },
  {
    "in": "query",
    "name": "tlsVersion",
    "schema": {
      "description": "Filter for tls version.",
      "example": "TLSv1_2",
      "items": {
        "enum": [
          "TLSv1_0",
          "TLSv1_1",
          "TLSv1_2",
          "TLSv1_3",
          "TLSvQUIC"
        ],
        "type": "string"
      },
      "type": "array"
    }
  },
  {
    "in": "query",
    "name": "format",
    "schema": {
      "description": "Format results are returned in.",
      "enum": [
        "JSON",
        "CSV"
      ],
      "example": "json",
      "type": "string"
    }
  }
]

Debug "requestBody"

null

Debug "responses"

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "properties": {
            "result": {
              "properties": {
                "meta": {
                  "type": "object"
                },
                "serie_0": {
                  "properties": {
                    "bot": {
                      "items": {
                        "type": "string"
                      },
                      "type": "array"
                    },
                    "human": {
                      "items": {
                        "type": "string"
                      },
                      "type": "array"
                    },
                    "timestamps": {
                      "items": {
                        "type": "string"
                      },
                      "type": "array"
                    }
                  },
                  "required": [
                    "timestamps",
                    "human",
                    "bot"
                  ],
                  "type": "object"
                }
              },
              "required": [
                "meta",
                "serie_0"
              ],
              "type": "object"
            },
            "success": {
              "example": true,
              "type": "boolean"
            }
          },
          "required": [
            "result",
            "success"
          ],
          "type": "object"
        }
      }
    },
    "description": "Successful Response"
  },
  "400": {
    "content": {
      "application/json": {
        "schema": {
          "properties": {
            "errors": {
              "items": {
                "properties": {
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "message"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "result": {
              "type": "object"
            },
            "success": {
              "example": false,
              "type": "boolean"
            }
          },
          "required": [
            "result",
            "success",
            "errors"
          ],
          "type": "object"
        }
      }
    },
    "description": "Bad Request"
  }
}

Debug "security"

[
  {
    "api_email": [],
    "api_key": []
  }
]