API Reference

Radar

Verified Bots

Top

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get top verified bot categories by HTTP requests

Deprecated: Use [Radar Bots API](https://developers.cloudflare.com/api/resources/radar/subresources/bots/) instead.

client.Radar.VerifiedBots.Top.Categories(ctx, query) (*VerifiedBotTopCategoriesResponse, error)

GET/radar/verified_bots/top/categories

Retrieves the top verified bot categories by HTTP requests, along with their corresponding percentage, over the total verified bot HTTP requests.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

User Details WriteUser Details Read

ParametersExpand Collapse

query VerifiedBotTopCategoriesParams

ASN param.Field[[]string]Optional

Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.

Continent param.Field[[]string]Optional

Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.

DateEnd param.Field[[]Time]Optional

End of the date range (inclusive).

DateRange param.Field[[]string]Optional

Filters results by date range. 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).

DateStart param.Field[[]Time]Optional

Start of the date range.

Format param.Field[VerifiedBotTopCategoriesParamsFormat]Optional

Format in which results will be returned.

const VerifiedBotTopCategoriesParamsFormatJson VerifiedBotTopCategoriesParamsFormat = "JSON"

const VerifiedBotTopCategoriesParamsFormatCsv VerifiedBotTopCategoriesParamsFormat = "CSV"

Limit param.Field[int64]Optional

Limits the number of objects returned in the response.

exclusiveMinimum

minimum0

Location param.Field[[]string]Optional

Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.

Name param.Field[[]string]Optional

Array of names used to label the series in the response.

ReturnsExpand Collapse

type VerifiedBotTopCategoriesResponse struct{…}

Meta VerifiedBotTopCategoriesResponseMeta

Metadata for the results.

ConfidenceInfo VerifiedBotTopCategoriesResponseMetaConfidenceInfo

Annotations []VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotation

DataSource VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource

Data source for annotations.

One of the following:

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceAll VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "ALL"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceAIBots VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "AI_BOTS"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceAIGateway VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "AI_GATEWAY"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceBGP VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "BGP"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceBots VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "BOTS"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceConnectionAnomaly VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "CONNECTION_ANOMALY"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceCT VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "CT"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceDNS VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "DNS"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceDNSMagnitude VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_MAGNITUDE"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceDNSAS112 VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_AS112"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceDos VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "DOS"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceEmailRouting VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_ROUTING"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceEmailSecurity VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_SECURITY"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceFw VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "FW"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceFwPg VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "FW_PG"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceHTTP VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceHTTPControl VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CONTROL"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceHTTPCrawlerReferer VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CRAWLER_REFERER"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceHTTPOrigins VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_ORIGINS"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceIQI VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "IQI"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceLeakedCredentials VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "LEAKED_CREDENTIALS"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceNet VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "NET"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceRobotsTXT VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "ROBOTS_TXT"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceSpeed VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "SPEED"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSourceWorkersAI VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsDataSource = "WORKERS_AI"

Description string

EndDate Time

formatdate-time

EventType VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsEventType

Event type for annotations.

One of the following:

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsEventTypeEvent VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsEventType = "EVENT"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsEventTypeGeneral VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsEventType = "GENERAL"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsEventTypeOutage VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsEventType = "OUTAGE"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsEventTypePartialProjection VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsEventType = "PARTIAL_PROJECTION"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsEventTypePipeline VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsEventType = "PIPELINE"

const VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsEventTypeTrafficAnomaly VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationsEventType = "TRAFFIC_ANOMALY"

IsInstantaneous bool

Whether event is a single point in time or a time range.

LinkedURL string

formaturi

StartDate Time

formatdate-time

Tags []stringOptional

Level int64

Provides an indication of how much confidence Cloudflare has in the data.

DateRange []VerifiedBotTopCategoriesResponseMetaDateRange

EndTime Time

Adjusted end of date range.

formatdate-time

StartTime Time

Adjusted start of date range.

formatdate-time

LastUpdated Time

Timestamp of the last dataset update.

formatdate-time

Normalization VerifiedBotTopCategoriesResponseMetaNormalization

Normalization method applied to the results. Refer to Normalization methods.

One of the following:

const VerifiedBotTopCategoriesResponseMetaNormalizationPercentage VerifiedBotTopCategoriesResponseMetaNormalization = "PERCENTAGE"

const VerifiedBotTopCategoriesResponseMetaNormalizationMin0Max VerifiedBotTopCategoriesResponseMetaNormalization = "MIN0_MAX"

const VerifiedBotTopCategoriesResponseMetaNormalizationMinMax VerifiedBotTopCategoriesResponseMetaNormalization = "MIN_MAX"

const VerifiedBotTopCategoriesResponseMetaNormalizationRawValues VerifiedBotTopCategoriesResponseMetaNormalization = "RAW_VALUES"

const VerifiedBotTopCategoriesResponseMetaNormalizationPercentageChange VerifiedBotTopCategoriesResponseMetaNormalization = "PERCENTAGE_CHANGE"

const VerifiedBotTopCategoriesResponseMetaNormalizationRollingAverage VerifiedBotTopCategoriesResponseMetaNormalization = "ROLLING_AVERAGE"

const VerifiedBotTopCategoriesResponseMetaNormalizationOverlappedPercentage VerifiedBotTopCategoriesResponseMetaNormalization = "OVERLAPPED_PERCENTAGE"

const VerifiedBotTopCategoriesResponseMetaNormalizationRatio VerifiedBotTopCategoriesResponseMetaNormalization = "RATIO"

Units []VerifiedBotTopCategoriesResponseMetaUnit

Measurement units for the results.

Name string

Value string

Top0 []VerifiedBotTopCategoriesResponseTop0

BotCategory string

Value string

A numeric string.

Get top verified bot categories by HTTP requests

Go

HTTP

TypeScript

Python

Go

Terraform

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/option"
  "github.com/stainless-sdks/cloudflare-go/radar"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.Radar.VerifiedBots.Top.Categories(context.TODO(), radar.VerifiedBotTopCategoriesParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Meta)
}

200 example

{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "isInstantaneous": true,
            "linkedUrl": "https://example.com",
            "startDate": "2019-12-27T18:11:19.117Z",
            "tags": [
              "BOT_CLASS"
            ]
          }
        ],
        "level": 0
      },
      "dateRange": [
        {
          "endTime": "2022-09-17T10:22:57.555Z",
          "startTime": "2022-09-16T10:22:57.555Z"
        }
      ],
      "lastUpdated": "2019-12-27T18:11:19.117Z",
      "normalization": "PERCENTAGE",
      "units": [
        {
          "name": "*",
          "value": "requests"
        }
      ]
    },
    "top_0": [
      {
        "botCategory": "Search",
        "value": "10"
      }
    ]
  },
  "success": true
}

Returns Examples

200 example

{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "isInstantaneous": true,
            "linkedUrl": "https://example.com",
            "startDate": "2019-12-27T18:11:19.117Z",
            "tags": [
              "BOT_CLASS"
            ]
          }
        ],
        "level": 0
      },
      "dateRange": [
        {
          "endTime": "2022-09-17T10:22:57.555Z",
          "startTime": "2022-09-16T10:22:57.555Z"
        }
      ],
      "lastUpdated": "2019-12-27T18:11:19.117Z",
      "normalization": "PERCENTAGE",
      "units": [
        {
          "name": "*",
          "value": "requests"
        }
      ]
    },
    "top_0": [
      {
        "botCategory": "Search",
        "value": "10"
      }
    ]
  },
  "success": true
}