## Get HTTP requests by bot class summary

`client.radar.http.summary.botClass(SummaryBotClassParamsquery?, RequestOptionsoptions?): SummaryBotClassResponse`

**get** `/radar/http/summary/bot_class`

Retrieves the distribution of bot-generated HTTP requests to genuine human traffic, as classified by Cloudflare. Visit https://developers.cloudflare.com/radar/concepts/bot-classes/ for more information.

### Parameters

- `query: SummaryBotClassParams`

  - `asn?: Array<string>`

    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.

  - `browserFamily?: Array<"CHROME" | "EDGE" | "FIREFOX" | "SAFARI">`

    Filters results by browser family.

    - `"CHROME"`

    - `"EDGE"`

    - `"FIREFOX"`

    - `"SAFARI"`

  - `continent?: Array<string>`

    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?: Array<string>`

    End of the date range (inclusive).

  - `dateRange?: Array<string>`

    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?: Array<string>`

    Start of the date range.

  - `deviceType?: Array<"DESKTOP" | "MOBILE" | "OTHER">`

    Filters results by device type.

    - `"DESKTOP"`

    - `"MOBILE"`

    - `"OTHER"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `geoId?: Array<string>`

    Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).

  - `httpProtocol?: Array<"HTTP" | "HTTPS">`

    Filters results by HTTP protocol (HTTP vs. HTTPS).

    - `"HTTP"`

    - `"HTTPS"`

  - `httpVersion?: Array<"HTTPv1" | "HTTPv2" | "HTTPv3">`

    Filters results by HTTP version.

    - `"HTTPv1"`

    - `"HTTPv2"`

    - `"HTTPv3"`

  - `ipVersion?: Array<"IPv4" | "IPv6">`

    Filters results by IP version (Ipv4 vs. IPv6).

    - `"IPv4"`

    - `"IPv6"`

  - `location?: Array<string>`

    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?: Array<string>`

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

  - `os?: Array<"WINDOWS" | "MACOSX" | "IOS" | 4 more>`

    Filters results by operating system.

    - `"WINDOWS"`

    - `"MACOSX"`

    - `"IOS"`

    - `"ANDROID"`

    - `"CHROMEOS"`

    - `"LINUX"`

    - `"SMART_TV"`

  - `tlsVersion?: Array<"TLSv1_0" | "TLSv1_1" | "TLSv1_2" | 2 more>`

    Filters results by TLS version.

    - `"TLSv1_0"`

    - `"TLSv1_1"`

    - `"TLSv1_2"`

    - `"TLSv1_3"`

    - `"TLSvQUIC"`

### Returns

- `SummaryBotClassResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

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

        - `linkedUrl: string`

        - `startDate: string`

      - `level: number`

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

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: Summary0`

    - `bot: string`

      A numeric string.

    - `human: string`

      A numeric string.

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.radar.http.summary.botClass();

console.log(response.meta);
```

#### Response

```json
{
  "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"
          }
        ],
        "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"
        }
      ]
    },
    "summary_0": {
      "bot": "10",
      "human": "10"
    }
  },
  "success": true
}
```