--- title: Bots --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Radar](https://developers.cloudflare.com/api/typescript/resources/radar) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Bots ##### [List bots](https://developers.cloudflare.com/api/typescript/resources/radar/subresources/bots/methods/list) client.radar.bots.list(BotListParams {botCategory, botOperator, botVerificationStatus, 4 more } query?, RequestOptionsoptions?): [BotListResponse]() {bots } GET/radar/bots ##### [Get bot details](https://developers.cloudflare.com/api/typescript/resources/radar/subresources/bots/methods/get) client.radar.bots.get(stringbotSlug, BotGetParams {format } query?, RequestOptionsoptions?): [BotGetResponse]() {bot } GET/radar/bots/{bot\_slug} ##### [Get bots HTTP requests distribution by dimension](https://developers.cloudflare.com/api/typescript/resources/radar/subresources/bots/methods/summary) client.radar.bots.summary("BOT"| "BOT\_KIND"| "BOT\_OPERATOR"| "BOT\_CATEGORY"dimension, BotSummaryParams {asn, bot, botCategory, 11 more } query?, RequestOptionsoptions?): [BotSummaryResponse]() {meta, summary\_0 } GET/radar/bots/summary/{dimension} ##### [Get bots HTTP requests time series](https://developers.cloudflare.com/api/typescript/resources/radar/subresources/bots/methods/timeseries) client.radar.bots.timeseries(BotTimeseriesParams {aggInterval, asn, bot, 11 more } query?, RequestOptionsoptions?): [BotTimeseriesResponse]() {meta } GET/radar/bots/timeseries ##### [Get time series distribution of bots HTTP requests by dimension.](https://developers.cloudflare.com/api/typescript/resources/radar/subresources/bots/methods/timeseries_groups) client.radar.bots.timeseriesGroups("BOT"| "BOT\_KIND"| "BOT\_OPERATOR"| "BOT\_CATEGORY"dimension, BotTimeseriesGroupsParams {aggInterval, asn, bot, 12 more } query?, RequestOptionsoptions?): [BotTimeseriesGroupsResponse]() {meta, serie\_0 } GET/radar/bots/timeseries\_groups/{dimension} ##### ModelsExpand Collapse
BotListResponse {bots }
bots: Array<Bot> category: string The category of the bot. Link to this property description: string A summary for the bot (e.g., purpose). Link to this property Deprecatedkind: string The kind of the bot. Link to this property name: string The name of the bot. Link to this property operator: string The organization that owns and operates the bot. Link to this property slug: string A kebab-case identifier derived from the bot name. Link to this property userAgentPatterns: Array<string> Link to this property
Link to this property
[Link to this property](<#(resource)%20radar.bots%20%3E%20(model)%20bot_list_response%20%3E%20(schema)>)
BotGetResponse {bot }
bot: Bot {category, description, kind, 7 more } category: string The category of the bot. Link to this property description: string A summary for the bot (e.g., purpose). Link to this property Deprecatedkind: string The kind of the bot. Link to this property name: string The name of the bot. Link to this property operator: string The organization that owns and operates the bot. Link to this property operatorUrl: string The link to the bot documentation. Link to this property slug: string A kebab-case identifier derived from the bot name. Link to this property userAgentPatterns: Array<string> Link to this property userAgents: Array<string> Link to this property signatureAgentUrl?: string| null The URL of the agent’s Web Bot Auth resource. Null for bots not verified via request signature. Link to this property
Link to this property
[Link to this property](<#(resource)%20radar.bots%20%3E%20(model)%20bot_get_response%20%3E%20(schema)>)
BotSummaryResponse {meta, summary\_0 }
meta: Meta {confidenceInfo, dateRange, lastUpdated, 2 more } Metadata for the results.
confidenceInfo: ConfidenceInfo {annotations, level }
annotations: Array<Annotation>
dataSource: "ALL"| "AI\_BOTS"| "AI\_GATEWAY"| 22 more Data source for annotations. One of the following: "ALL" Link to this property "AI\_BOTS" Link to this property "AI\_GATEWAY" Link to this property "BGP" Link to this property "BOTS" Link to this property "CONNECTION\_ANOMALY" Link to this property "CT" Link to this property "DNS" Link to this property "DNS\_MAGNITUDE" Link to this property "DNS\_AS112" Link to this property "DOS" Link to this property "EMAIL\_ROUTING" Link to this property "EMAIL\_SECURITY" Link to this property "FW" Link to this property "FW\_PG" Link to this property "HTTP" Link to this property "HTTP\_CONTROL" Link to this property "HTTP\_CRAWLER\_REFERER" Link to this property "HTTP\_ORIGINS" Link to this property "IQI" Link to this property "LEAKED\_CREDENTIALS" Link to this property "NET" Link to this property "ROBOTS\_TXT" Link to this property "SPEED" Link to this property "WORKERS\_AI" Link to this property
Link to this property description: string Link to this property endDate: string formatdate-time Link to this property
eventType: "GENERAL"| "OUTAGE"| "PARTIAL\_PROJECTION"| 2 more Event type for annotations. One of the following: "GENERAL" Link to this property "OUTAGE" Link to this property "PARTIAL\_PROJECTION" Link to this property "PIPELINE" Link to this property "TRAFFIC\_ANOMALY" Link to this property
Link to this property isInstantaneous: boolean Whether event is a single point in time or a time range. Link to this property linkedUrl: string formaturi Link to this property startDate: string formatdate-time Link to this property tags?: Array<string> Link to this property
Link to this property level: number Provides an indication of how much confidence Cloudflare has in the data. Link to this property
Link to this property
dateRange: Array<DateRange> endTime: string Adjusted end of date range. formatdate-time Link to this property startTime: string Adjusted start of date range. formatdate-time Link to this property
Link to this property lastUpdated: string Timestamp of the last dataset update. formatdate-time Link to this property
normalization: "PERCENTAGE"| "MIN0\_MAX"| "MIN\_MAX"| 5 more Normalization method applied to the results. Refer to Normalization methods. One of the following: "PERCENTAGE" Link to this property "MIN0\_MAX" Link to this property "MIN\_MAX" Link to this property "RAW\_VALUES" Link to this property "PERCENTAGE\_CHANGE" Link to this property "ROLLING\_AVERAGE" Link to this property "OVERLAPPED\_PERCENTAGE" Link to this property "RATIO" Link to this property
Link to this property
units: Array<Unit> Measurement units for the results. name: string Link to this property value: string Link to this property
Link to this property
Link to this property summary\_0: Record<string, string> Link to this property
[Link to this property](<#(resource)%20radar.bots%20%3E%20(model)%20bot_summary_response%20%3E%20(schema)>)
BotTimeseriesResponse {meta }
meta: Meta {aggInterval, confidenceInfo, dateRange, 3 more } 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. One of the following: "FIFTEEN\_MINUTES" Link to this property "ONE\_HOUR" Link to this property "ONE\_DAY" Link to this property "ONE\_WEEK" Link to this property "ONE\_MONTH" Link to this property
Link to this property
confidenceInfo: ConfidenceInfo {annotations, level }
annotations: Array<Annotation>
dataSource: "ALL"| "AI\_BOTS"| "AI\_GATEWAY"| 22 more Data source for annotations. One of the following: "ALL" Link to this property "AI\_BOTS" Link to this property "AI\_GATEWAY" Link to this property "BGP" Link to this property "BOTS" Link to this property "CONNECTION\_ANOMALY" Link to this property "CT" Link to this property "DNS" Link to this property "DNS\_MAGNITUDE" Link to this property "DNS\_AS112" Link to this property "DOS" Link to this property "EMAIL\_ROUTING" Link to this property "EMAIL\_SECURITY" Link to this property "FW" Link to this property "FW\_PG" Link to this property "HTTP" Link to this property "HTTP\_CONTROL" Link to this property "HTTP\_CRAWLER\_REFERER" Link to this property "HTTP\_ORIGINS" Link to this property "IQI" Link to this property "LEAKED\_CREDENTIALS" Link to this property "NET" Link to this property "ROBOTS\_TXT" Link to this property "SPEED" Link to this property "WORKERS\_AI" Link to this property
Link to this property description: string Link to this property endDate: string formatdate-time Link to this property
eventType: "GENERAL"| "OUTAGE"| "PARTIAL\_PROJECTION"| 2 more Event type for annotations. One of the following: "GENERAL" Link to this property "OUTAGE" Link to this property "PARTIAL\_PROJECTION" Link to this property "PIPELINE" Link to this property "TRAFFIC\_ANOMALY" Link to this property
Link to this property isInstantaneous: boolean Whether event is a single point in time or a time range. Link to this property linkedUrl: string formaturi Link to this property startDate: string formatdate-time Link to this property tags?: Array<string> Link to this property
Link to this property level: number Provides an indication of how much confidence Cloudflare has in the data. Link to this property
Link to this property
dateRange: Array<DateRange> endTime: string Adjusted end of date range. formatdate-time Link to this property startTime: string Adjusted start of date range. formatdate-time Link to this property
Link to this property lastUpdated: string Timestamp of the last dataset update. formatdate-time Link to this property
normalization: "PERCENTAGE"| "MIN0\_MAX"| "MIN\_MAX"| 5 more Normalization method applied to the results. Refer to Normalization methods. One of the following: "PERCENTAGE" Link to this property "MIN0\_MAX" Link to this property "MIN\_MAX" Link to this property "RAW\_VALUES" Link to this property "PERCENTAGE\_CHANGE" Link to this property "ROLLING\_AVERAGE" Link to this property "OVERLAPPED\_PERCENTAGE" Link to this property "RATIO" Link to this property
Link to this property
units: Array<Unit> Measurement units for the results. name: string Link to this property value: string Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20radar.bots%20%3E%20(model)%20bot_timeseries_response%20%3E%20(schema)>)
BotTimeseriesGroupsResponse {meta, serie\_0 }
meta: Meta {aggInterval, confidenceInfo, dateRange, 3 more } 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. One of the following: "FIFTEEN\_MINUTES" Link to this property "ONE\_HOUR" Link to this property "ONE\_DAY" Link to this property "ONE\_WEEK" Link to this property "ONE\_MONTH" Link to this property
Link to this property
confidenceInfo: ConfidenceInfo {annotations, level }
annotations: Array<Annotation>
dataSource: "ALL"| "AI\_BOTS"| "AI\_GATEWAY"| 22 more Data source for annotations. One of the following: "ALL" Link to this property "AI\_BOTS" Link to this property "AI\_GATEWAY" Link to this property "BGP" Link to this property "BOTS" Link to this property "CONNECTION\_ANOMALY" Link to this property "CT" Link to this property "DNS" Link to this property "DNS\_MAGNITUDE" Link to this property "DNS\_AS112" Link to this property "DOS" Link to this property "EMAIL\_ROUTING" Link to this property "EMAIL\_SECURITY" Link to this property "FW" Link to this property "FW\_PG" Link to this property "HTTP" Link to this property "HTTP\_CONTROL" Link to this property "HTTP\_CRAWLER\_REFERER" Link to this property "HTTP\_ORIGINS" Link to this property "IQI" Link to this property "LEAKED\_CREDENTIALS" Link to this property "NET" Link to this property "ROBOTS\_TXT" Link to this property "SPEED" Link to this property "WORKERS\_AI" Link to this property
Link to this property description: string Link to this property endDate: string formatdate-time Link to this property
eventType: "GENERAL"| "OUTAGE"| "PARTIAL\_PROJECTION"| 2 more Event type for annotations. One of the following: "GENERAL" Link to this property "OUTAGE" Link to this property "PARTIAL\_PROJECTION" Link to this property "PIPELINE" Link to this property "TRAFFIC\_ANOMALY" Link to this property
Link to this property isInstantaneous: boolean Whether event is a single point in time or a time range. Link to this property linkedUrl: string formaturi Link to this property startDate: string formatdate-time Link to this property tags?: Array<string> Link to this property
Link to this property level: number Provides an indication of how much confidence Cloudflare has in the data. Link to this property
Link to this property
dateRange: Array<DateRange> endTime: string Adjusted end of date range. formatdate-time Link to this property startTime: string Adjusted start of date range. formatdate-time Link to this property
Link to this property lastUpdated: string Timestamp of the last dataset update. formatdate-time Link to this property
normalization: "PERCENTAGE"| "MIN0\_MAX"| "MIN\_MAX"| 5 more Normalization method applied to the results. Refer to Normalization methods. One of the following: "PERCENTAGE" Link to this property "MIN0\_MAX" Link to this property "MIN\_MAX" Link to this property "RAW\_VALUES" Link to this property "PERCENTAGE\_CHANGE" Link to this property "ROLLING\_AVERAGE" Link to this property "OVERLAPPED\_PERCENTAGE" Link to this property "RATIO" Link to this property
Link to this property
units: Array<Unit> Measurement units for the results. name: string Link to this property value: string Link to this property
Link to this property
Link to this property
serie\_0: Serie0 {timestamps } timestamps: Array<string> Link to this property
Link to this property
[Link to this property](<#(resource)%20radar.bots%20%3E%20(model)%20bot_timeseries_groups_response%20%3E%20(schema)>) #### BotsWeb Crawlers ##### [Get crawler HTTP request distribution by dimension](https://developers.cloudflare.com/api/typescript/resources/radar/subresources/bots/subresources/web_crawlers/methods/summary) client.radar.bots.webCrawlers.summary("CLIENT\_TYPE"| "USER\_AGENT"| "REFERER"| 5 moredimension, WebCrawlerSummaryParams {botOperator, clientType, dateEnd, 9 more } query?, RequestOptionsoptions?): [WebCrawlerSummaryResponse]() {meta, summary\_0 } GET/radar/bots/crawlers/summary/{dimension} ##### [Get time series of crawler HTTP request distribution by dimension](https://developers.cloudflare.com/api/typescript/resources/radar/subresources/bots/subresources/web_crawlers/methods/timeseries_groups) client.radar.bots.webCrawlers.timeseriesGroups("CLIENT\_TYPE"| "USER\_AGENT"| "REFERER"| 5 moredimension, WebCrawlerTimeseriesGroupsParams {aggInterval, botOperator, clientType, 11 more } query?, RequestOptionsoptions?): [WebCrawlerTimeseriesGroupsResponse]() {meta, serie\_0 } GET/radar/bots/crawlers/timeseries\_groups/{dimension} ##### ModelsExpand Collapse
WebCrawlerSummaryResponse {meta, summary\_0 }
meta: Meta {confidenceInfo, dateRange, lastUpdated, 2 more } Metadata for the results.
confidenceInfo: ConfidenceInfo {annotations, level }
annotations: Array<Annotation>
dataSource: "ALL"| "AI\_BOTS"| "AI\_GATEWAY"| 22 more Data source for annotations. One of the following: "ALL" Link to this property "AI\_BOTS" Link to this property "AI\_GATEWAY" Link to this property "BGP" Link to this property "BOTS" Link to this property "CONNECTION\_ANOMALY" Link to this property "CT" Link to this property "DNS" Link to this property "DNS\_MAGNITUDE" Link to this property "DNS\_AS112" Link to this property "DOS" Link to this property "EMAIL\_ROUTING" Link to this property "EMAIL\_SECURITY" Link to this property "FW" Link to this property "FW\_PG" Link to this property "HTTP" Link to this property "HTTP\_CONTROL" Link to this property "HTTP\_CRAWLER\_REFERER" Link to this property "HTTP\_ORIGINS" Link to this property "IQI" Link to this property "LEAKED\_CREDENTIALS" Link to this property "NET" Link to this property "ROBOTS\_TXT" Link to this property "SPEED" Link to this property "WORKERS\_AI" Link to this property
Link to this property description: string Link to this property endDate: string formatdate-time Link to this property
eventType: "GENERAL"| "OUTAGE"| "PARTIAL\_PROJECTION"| 2 more Event type for annotations. One of the following: "GENERAL" Link to this property "OUTAGE" Link to this property "PARTIAL\_PROJECTION" Link to this property "PIPELINE" Link to this property "TRAFFIC\_ANOMALY" Link to this property
Link to this property isInstantaneous: boolean Whether event is a single point in time or a time range. Link to this property linkedUrl: string formaturi Link to this property startDate: string formatdate-time Link to this property tags?: Array<string> Link to this property
Link to this property level: number Provides an indication of how much confidence Cloudflare has in the data. Link to this property
Link to this property
dateRange: Array<DateRange> endTime: string Adjusted end of date range. formatdate-time Link to this property startTime: string Adjusted start of date range. formatdate-time Link to this property
Link to this property lastUpdated: string Timestamp of the last dataset update. formatdate-time Link to this property
normalization: "PERCENTAGE"| "MIN0\_MAX"| "MIN\_MAX"| 5 more Normalization method applied to the results. Refer to Normalization methods. One of the following: "PERCENTAGE" Link to this property "MIN0\_MAX" Link to this property "MIN\_MAX" Link to this property "RAW\_VALUES" Link to this property "PERCENTAGE\_CHANGE" Link to this property "ROLLING\_AVERAGE" Link to this property "OVERLAPPED\_PERCENTAGE" Link to this property "RATIO" Link to this property
Link to this property
units: Array<Unit> Measurement units for the results. name: string Link to this property value: string Link to this property
Link to this property
Link to this property summary\_0: Record<string, string> Link to this property
[Link to this property](<#(resource)%20radar.bots.web_crawlers%20%3E%20(model)%20web_crawler_summary_response%20%3E%20(schema)>)
WebCrawlerTimeseriesGroupsResponse {meta, serie\_0 }
meta: Meta {aggInterval, confidenceInfo, dateRange, 3 more } 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. One of the following: "FIFTEEN\_MINUTES" Link to this property "ONE\_HOUR" Link to this property "ONE\_DAY" Link to this property "ONE\_WEEK" Link to this property "ONE\_MONTH" Link to this property
Link to this property
confidenceInfo: ConfidenceInfo {annotations, level }
annotations: Array<Annotation>
dataSource: "ALL"| "AI\_BOTS"| "AI\_GATEWAY"| 22 more Data source for annotations. One of the following: "ALL" Link to this property "AI\_BOTS" Link to this property "AI\_GATEWAY" Link to this property "BGP" Link to this property "BOTS" Link to this property "CONNECTION\_ANOMALY" Link to this property "CT" Link to this property "DNS" Link to this property "DNS\_MAGNITUDE" Link to this property "DNS\_AS112" Link to this property "DOS" Link to this property "EMAIL\_ROUTING" Link to this property "EMAIL\_SECURITY" Link to this property "FW" Link to this property "FW\_PG" Link to this property "HTTP" Link to this property "HTTP\_CONTROL" Link to this property "HTTP\_CRAWLER\_REFERER" Link to this property "HTTP\_ORIGINS" Link to this property "IQI" Link to this property "LEAKED\_CREDENTIALS" Link to this property "NET" Link to this property "ROBOTS\_TXT" Link to this property "SPEED" Link to this property "WORKERS\_AI" Link to this property
Link to this property description: string Link to this property endDate: string formatdate-time Link to this property
eventType: "GENERAL"| "OUTAGE"| "PARTIAL\_PROJECTION"| 2 more Event type for annotations. One of the following: "GENERAL" Link to this property "OUTAGE" Link to this property "PARTIAL\_PROJECTION" Link to this property "PIPELINE" Link to this property "TRAFFIC\_ANOMALY" Link to this property
Link to this property isInstantaneous: boolean Whether event is a single point in time or a time range. Link to this property linkedUrl: string formaturi Link to this property startDate: string formatdate-time Link to this property tags?: Array<string> Link to this property
Link to this property level: number Provides an indication of how much confidence Cloudflare has in the data. Link to this property
Link to this property
dateRange: Array<DateRange> endTime: string Adjusted end of date range. formatdate-time Link to this property startTime: string Adjusted start of date range. formatdate-time Link to this property
Link to this property lastUpdated: string Timestamp of the last dataset update. formatdate-time Link to this property
normalization: "PERCENTAGE"| "MIN0\_MAX"| "MIN\_MAX"| 5 more Normalization method applied to the results. Refer to Normalization methods. One of the following: "PERCENTAGE" Link to this property "MIN0\_MAX" Link to this property "MIN\_MAX" Link to this property "RAW\_VALUES" Link to this property "PERCENTAGE\_CHANGE" Link to this property "ROLLING\_AVERAGE" Link to this property "OVERLAPPED\_PERCENTAGE" Link to this property "RATIO" Link to this property
Link to this property
units: Array<Unit> Measurement units for the results. name: string Link to this property value: string Link to this property
Link to this property
Link to this property
serie\_0: Serie0 {timestamps } timestamps: Array<string> Link to this property
Link to this property
[Link to this property](<#(resource)%20radar.bots.web_crawlers%20%3E%20(model)%20web_crawler_timeseries_groups_response%20%3E%20(schema)>)