# Bots

## List bots

`client.radar.bots.list(BotListParamsquery?, RequestOptionsoptions?): BotListResponse`

**get** `/radar/bots`

Retrieves a list of bots.

### Parameters

- `query: BotListParams`

  - `botCategory?: "SEARCH_ENGINE_CRAWLER" | "SEARCH_ENGINE_OPTIMIZATION" | "MONITORING_AND_ANALYTICS" | 13 more`

    Filters results by bot category.

    - `"SEARCH_ENGINE_CRAWLER"`

    - `"SEARCH_ENGINE_OPTIMIZATION"`

    - `"MONITORING_AND_ANALYTICS"`

    - `"ADVERTISING_AND_MARKETING"`

    - `"SOCIAL_MEDIA_MARKETING"`

    - `"PAGE_PREVIEW"`

    - `"ACADEMIC_RESEARCH"`

    - `"SECURITY"`

    - `"ACCESSIBILITY"`

    - `"WEBHOOKS"`

    - `"FEED_FETCHER"`

    - `"AI_CRAWLER"`

    - `"AGGREGATOR"`

    - `"AI_ASSISTANT"`

    - `"AI_SEARCH"`

    - `"ARCHIVER"`

  - `botOperator?: string`

    Filters results by bot operator.

  - `botVerificationStatus?: "VERIFIED"`

    Filters results by bot verification status.

    - `"VERIFIED"`

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

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `kind?: "AGENT" | "BOT"`

    Filters results by bot kind.

    - `"AGENT"`

    - `"BOT"`

  - `limit?: number`

    Limits the number of objects returned in the response.

  - `offset?: number`

    Skips the specified number of objects before fetching the results.

### Returns

- `BotListResponse`

  - `bots: Array<Bot>`

    - `category: string`

      The category of the bot.

    - `description: string`

      A summary for the bot (e.g., purpose).

    - `kind: string`

      The kind of the bot.

    - `name: string`

      The name of the bot.

    - `operator: string`

      The organization that owns and operates the bot.

    - `slug: string`

      A kebab-case identifier derived from the bot name.

    - `userAgentPatterns: Array<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 bots = await client.radar.bots.list();

console.log(bots.bots);
```

#### Response

```json
{
  "result": {
    "bots": [
      {
        "category": "AI_CRAWLER",
        "description": "OpenAI/ChatGPT's web crawler",
        "kind": "AGENT",
        "name": "GPTBot",
        "operator": "OpenAI",
        "slug": "gptbot",
        "userAgentPatterns": [
          "GPTBot"
        ]
      }
    ]
  },
  "success": true
}
```

## Get bot details

`client.radar.bots.get(stringbotSlug, BotGetParamsquery?, RequestOptionsoptions?): BotGetResponse`

**get** `/radar/bots/{bot_slug}`

Retrieves the requested bot information.

### Parameters

- `botSlug: string`

  Bot slug.

- `query: BotGetParams`

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

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

### Returns

- `BotGetResponse`

  - `bot: Bot`

    - `category: string`

      The category of the bot.

    - `description: string`

      A summary for the bot (e.g., purpose).

    - `kind: string`

      The kind of the bot.

    - `name: string`

      The name of the bot.

    - `operator: string`

      The organization that owns and operates the bot.

    - `operatorUrl: string`

      The link to the bot documentation.

    - `slug: string`

      A kebab-case identifier derived from the bot name.

    - `userAgentPatterns: Array<string>`

    - `userAgents: Array<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 bot = await client.radar.bots.get('gptbot');

console.log(bot.bot);
```

#### Response

```json
{
  "result": {
    "bot": {
      "category": "AI_CRAWLER",
      "description": "OpenAI/ChatGPT's web crawler",
      "kind": "AGENT",
      "name": "GPTBot",
      "operator": "OpenAI",
      "operatorUrl": "https://platform.openai.com/docs/bots",
      "slug": "gptbot",
      "userAgentPatterns": [
        "GPTBot"
      ],
      "userAgents": [
        "GPTBot"
      ]
    }
  },
  "success": true
}
```

## Get bots HTTP requests distribution by dimension

`client.radar.bots.summary("BOT" | "BOT_KIND" | "BOT_OPERATOR" | "BOT_CATEGORY"dimension, BotSummaryParamsquery?, RequestOptionsoptions?): BotSummaryResponse`

**get** `/radar/bots/summary/{dimension}`

Retrieves an aggregated summary of bots HTTP requests grouped by the specified dimension.

### Parameters

- `dimension: "BOT" | "BOT_KIND" | "BOT_OPERATOR" | "BOT_CATEGORY"`

  Specifies the attribute by which to group the results.

  - `"BOT"`

  - `"BOT_KIND"`

  - `"BOT_OPERATOR"`

  - `"BOT_CATEGORY"`

- `query: BotSummaryParams`

  - `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.

  - `bot?: Array<string>`

    Filters results by bot name.

  - `botCategory?: Array<"SEARCH_ENGINE_CRAWLER" | "SEARCH_ENGINE_OPTIMIZATION" | "MONITORING_AND_ANALYTICS" | 13 more>`

    Filters results by bot category.

    - `"SEARCH_ENGINE_CRAWLER"`

    - `"SEARCH_ENGINE_OPTIMIZATION"`

    - `"MONITORING_AND_ANALYTICS"`

    - `"ADVERTISING_AND_MARKETING"`

    - `"SOCIAL_MEDIA_MARKETING"`

    - `"PAGE_PREVIEW"`

    - `"ACADEMIC_RESEARCH"`

    - `"SECURITY"`

    - `"ACCESSIBILITY"`

    - `"WEBHOOKS"`

    - `"FEED_FETCHER"`

    - `"AI_CRAWLER"`

    - `"AGGREGATOR"`

    - `"AI_ASSISTANT"`

    - `"AI_SEARCH"`

    - `"ARCHIVER"`

  - `botKind?: Array<"AGENT" | "BOT">`

    Filters results by bot kind.

    - `"AGENT"`

    - `"BOT"`

  - `botOperator?: Array<string>`

    Filters results by bot operator.

  - `botVerificationStatus?: Array<"VERIFIED">`

    Filters results by bot verification status (Verified vs. Unverified).

    - `"VERIFIED"`

  - `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.

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

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `limitPerGroup?: number`

    Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category.

  - `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.

### Returns

- `BotSummaryResponse`

  - `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: Record<string, 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.bots.summary('BOT');

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": {
      "Facebook": "10.274394",
      "GPTBot": "63.40249",
      "GoogleBot": "8.381743"
    }
  },
  "success": true
}
```

## Get bots HTTP requests time series

`client.radar.bots.timeseries(BotTimeseriesParamsquery?, RequestOptionsoptions?): BotTimeseriesResponse`

**get** `/radar/bots/timeseries`

Retrieves bots HTTP request volume over time.

### Parameters

- `query: BotTimeseriesParams`

  - `aggInterval?: "15m" | "1h" | "1d" | "1w"`

    Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

    - `"15m"`

    - `"1h"`

    - `"1d"`

    - `"1w"`

  - `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.

  - `bot?: Array<string>`

    Filters results by bot name.

  - `botCategory?: Array<"SEARCH_ENGINE_CRAWLER" | "SEARCH_ENGINE_OPTIMIZATION" | "MONITORING_AND_ANALYTICS" | 13 more>`

    Filters results by bot category.

    - `"SEARCH_ENGINE_CRAWLER"`

    - `"SEARCH_ENGINE_OPTIMIZATION"`

    - `"MONITORING_AND_ANALYTICS"`

    - `"ADVERTISING_AND_MARKETING"`

    - `"SOCIAL_MEDIA_MARKETING"`

    - `"PAGE_PREVIEW"`

    - `"ACADEMIC_RESEARCH"`

    - `"SECURITY"`

    - `"ACCESSIBILITY"`

    - `"WEBHOOKS"`

    - `"FEED_FETCHER"`

    - `"AI_CRAWLER"`

    - `"AGGREGATOR"`

    - `"AI_ASSISTANT"`

    - `"AI_SEARCH"`

    - `"ARCHIVER"`

  - `botKind?: Array<"AGENT" | "BOT">`

    Filters results by bot kind.

    - `"AGENT"`

    - `"BOT"`

  - `botOperator?: Array<string>`

    Filters results by bot operator.

  - `botVerificationStatus?: Array<"VERIFIED">`

    Filters results by bot verification status (Verified vs. Unverified).

    - `"VERIFIED"`

  - `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.

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

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `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.

### Returns

- `BotTimeseriesResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `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`

### 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.bots.timeseries();

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

#### Response

```json
{
  "result": {
    "meta": {
      "aggInterval": "FIFTEEN_MINUTES",
      "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"
        }
      ]
    }
  },
  "success": true
}
```

## Get time series distribution of bots HTTP requests by dimension.

`client.radar.bots.timeseriesGroups("BOT" | "BOT_KIND" | "BOT_OPERATOR" | "BOT_CATEGORY"dimension, BotTimeseriesGroupsParamsquery?, RequestOptionsoptions?): BotTimeseriesGroupsResponse`

**get** `/radar/bots/timeseries_groups/{dimension}`

Retrieves the distribution of HTTP requests from bots, grouped by the specified dimension over time.

### Parameters

- `dimension: "BOT" | "BOT_KIND" | "BOT_OPERATOR" | "BOT_CATEGORY"`

  Specifies the attribute by which to group the results.

  - `"BOT"`

  - `"BOT_KIND"`

  - `"BOT_OPERATOR"`

  - `"BOT_CATEGORY"`

- `query: BotTimeseriesGroupsParams`

  - `aggInterval?: "15m" | "1h" | "1d" | "1w"`

    Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

    - `"15m"`

    - `"1h"`

    - `"1d"`

    - `"1w"`

  - `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.

  - `bot?: Array<string>`

    Filters results by bot name.

  - `botCategory?: Array<"SEARCH_ENGINE_CRAWLER" | "SEARCH_ENGINE_OPTIMIZATION" | "MONITORING_AND_ANALYTICS" | 13 more>`

    Filters results by bot category.

    - `"SEARCH_ENGINE_CRAWLER"`

    - `"SEARCH_ENGINE_OPTIMIZATION"`

    - `"MONITORING_AND_ANALYTICS"`

    - `"ADVERTISING_AND_MARKETING"`

    - `"SOCIAL_MEDIA_MARKETING"`

    - `"PAGE_PREVIEW"`

    - `"ACADEMIC_RESEARCH"`

    - `"SECURITY"`

    - `"ACCESSIBILITY"`

    - `"WEBHOOKS"`

    - `"FEED_FETCHER"`

    - `"AI_CRAWLER"`

    - `"AGGREGATOR"`

    - `"AI_ASSISTANT"`

    - `"AI_SEARCH"`

    - `"ARCHIVER"`

  - `botKind?: Array<"AGENT" | "BOT">`

    Filters results by bot kind.

    - `"AGENT"`

    - `"BOT"`

  - `botOperator?: Array<string>`

    Filters results by bot operator.

  - `botVerificationStatus?: Array<"VERIFIED">`

    Filters results by bot verification status (Verified vs. Unverified).

    - `"VERIFIED"`

  - `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.

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

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `limitPerGroup?: number`

    Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category.

  - `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.

### Returns

- `BotTimeseriesGroupsResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `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`

  - `serie_0: Serie0`

    - `timestamps: Array<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.bots.timeseriesGroups('BOT');

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

#### Response

```json
{
  "result": {
    "meta": {
      "aggInterval": "FIFTEEN_MINUTES",
      "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"
        }
      ]
    },
    "serie_0": {
      "timestamps": [
        "2023-08-08T10:15:00Z"
      ]
    }
  },
  "success": true
}
```

## Domain Types

### Bot List Response

- `BotListResponse`

  - `bots: Array<Bot>`

    - `category: string`

      The category of the bot.

    - `description: string`

      A summary for the bot (e.g., purpose).

    - `kind: string`

      The kind of the bot.

    - `name: string`

      The name of the bot.

    - `operator: string`

      The organization that owns and operates the bot.

    - `slug: string`

      A kebab-case identifier derived from the bot name.

    - `userAgentPatterns: Array<string>`

### Bot Get Response

- `BotGetResponse`

  - `bot: Bot`

    - `category: string`

      The category of the bot.

    - `description: string`

      A summary for the bot (e.g., purpose).

    - `kind: string`

      The kind of the bot.

    - `name: string`

      The name of the bot.

    - `operator: string`

      The organization that owns and operates the bot.

    - `operatorUrl: string`

      The link to the bot documentation.

    - `slug: string`

      A kebab-case identifier derived from the bot name.

    - `userAgentPatterns: Array<string>`

    - `userAgents: Array<string>`

### Bot Summary Response

- `BotSummaryResponse`

  - `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: Record<string, string>`

### Bot Timeseries Response

- `BotTimeseriesResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `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`

### Bot Timeseries Groups Response

- `BotTimeseriesGroupsResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `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`

  - `serie_0: Serie0`

    - `timestamps: Array<string>`

# Web Crawlers

## Get crawler HTTP request distribution by dimension

`client.radar.bots.webCrawlers.summary("CLIENT_TYPE" | "USER_AGENT" | "REFERER" | 3 moredimension, WebCrawlerSummaryParamsquery?, RequestOptionsoptions?): WebCrawlerSummaryResponse`

**get** `/radar/bots/crawlers/summary/{dimension}`

Retrieves an aggregated summary of HTTP requests from crawlers, grouped by the specified dimension.

### Parameters

- `dimension: "CLIENT_TYPE" | "USER_AGENT" | "REFERER" | 3 more`

  Specifies the attribute by which to group the results.

  - `"CLIENT_TYPE"`

  - `"USER_AGENT"`

  - `"REFERER"`

  - `"CRAWL_REFER_RATIO"`

  - `"VERTICAL"`

  - `"INDUSTRY"`

- `query: WebCrawlerSummaryParams`

  - `botOperator?: Array<string>`

    Filters results by bot operator.

  - `clientType?: Array<"HUMAN" | "NON_AI_BOT" | "AI_BOT" | "MIXED_PURPOSE">`

    Filters results by agent type.

    - `"HUMAN"`

    - `"NON_AI_BOT"`

    - `"AI_BOT"`

    - `"MIXED_PURPOSE"`

  - `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.

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

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `industry?: Array<string>`

    Filters results by industry.

  - `limitPerGroup?: number`

    Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category.

  - `name?: Array<string>`

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

  - `vertical?: Array<string>`

    Filters results by vertical.

### Returns

- `WebCrawlerSummaryResponse`

  - `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: Record<string, 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.bots.webCrawlers.summary('CLIENT_TYPE');

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": {
      "Claude": "63.40249",
      "DuckDuckGo": "10.274394",
      "Google": "8.381743"
    }
  },
  "success": true
}
```

## Get time series of crawler HTTP request distribution by dimension

`client.radar.bots.webCrawlers.timeseriesGroups("CLIENT_TYPE" | "USER_AGENT" | "REFERER" | 3 moredimension, WebCrawlerTimeseriesGroupsParamsquery?, RequestOptionsoptions?): WebCrawlerTimeseriesGroupsResponse`

**get** `/radar/bots/crawlers/timeseries_groups/{dimension}`

Retrieves the distribution of HTTP requests from crawlers, grouped by the specified dimension over time.

### Parameters

- `dimension: "CLIENT_TYPE" | "USER_AGENT" | "REFERER" | 3 more`

  Specifies the attribute by which to group the results.

  - `"CLIENT_TYPE"`

  - `"USER_AGENT"`

  - `"REFERER"`

  - `"CRAWL_REFER_RATIO"`

  - `"VERTICAL"`

  - `"INDUSTRY"`

- `query: WebCrawlerTimeseriesGroupsParams`

  - `aggInterval?: "15m" | "1h" | "1d" | "1w"`

    Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

    - `"15m"`

    - `"1h"`

    - `"1d"`

    - `"1w"`

  - `botOperator?: Array<string>`

    Filters results by bot operator.

  - `clientType?: Array<"HUMAN" | "NON_AI_BOT" | "AI_BOT" | "MIXED_PURPOSE">`

    Filters results by agent type.

    - `"HUMAN"`

    - `"NON_AI_BOT"`

    - `"AI_BOT"`

    - `"MIXED_PURPOSE"`

  - `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.

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

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `industry?: Array<string>`

    Filters results by industry.

  - `limitPerGroup?: number`

    Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category.

  - `name?: Array<string>`

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

  - `vertical?: Array<string>`

    Filters results by vertical.

### Returns

- `WebCrawlerTimeseriesGroupsResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `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`

  - `serie_0: Serie0`

    - `timestamps: Array<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.bots.webCrawlers.timeseriesGroups('CLIENT_TYPE');

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

#### Response

```json
{
  "result": {
    "meta": {
      "aggInterval": "FIFTEEN_MINUTES",
      "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"
        }
      ]
    },
    "serie_0": {
      "timestamps": [
        "2023-08-08T10:15:00Z"
      ]
    }
  },
  "success": true
}
```

## Domain Types

### Web Crawler Summary Response

- `WebCrawlerSummaryResponse`

  - `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: Record<string, string>`

### Web Crawler Timeseries Groups Response

- `WebCrawlerTimeseriesGroupsResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `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`

  - `serie_0: Serie0`

    - `timestamps: Array<string>`