ai_bots_summary

Creates, updates, deletes, gets or lists an ai_bots_summary resource.

Overview

Name	ai_bots_summary
Type	Resource
Id	cloudflare.radar.ai_bots_summary

Fields

The following fields are returned by SELECT queries:

get

Successful response.

Name	Datatype	Description
meta	object	Metadata for the results.
summary_0	object

list_by_user_agent

Successful response.

Name	Datatype	Description
meta	object	Metadata for the results.
summary_0	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	dimension	name, dateRange, dateStart, dateEnd, asn, location, continent, crawlPurpose, userAgent, vertical, industry, contentType, responseStatus, responseStatusCategory, limitPerGroup, format	Retrieves an aggregated summary of AI bots HTTP requests grouped by the specified dimension.
list_by_user_agent	select		name, dateRange, dateStart, dateEnd, asn, location, continent, limitPerGroup, format	Retrieves the distribution of traffic by AI user agent.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
dimension	string	Specifies the attribute by which to group the results.
asn	array	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.
contentType	array	Filters results by content type category.
continent	array	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.
crawlPurpose	array	Filters results by bot crawl purpose.
dateEnd	array	End of the date range (inclusive).
dateRange	array	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	Start of the date range.
format	string	Format in which results will be returned.
industry	array	Filters results by industry.
limitPerGroup	integer	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	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	Array of names used to label the series in the response.
responseStatus	array	Filters results by HTTP response status code (e.g. 200, 403, 404). Only IANA-registered codes are accepted.
responseStatusCategory	array	Filters results by HTTP response status code category.
userAgent	array	Filters results by user agent.
vertical	array	Filters results by vertical.

SELECT examples

get

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

SELECT
meta,
summary_0
FROM cloudflare.radar.ai_bots_summary
WHERE dimension = '{{ dimension }}' -- required
AND name = '{{ name }}'
AND dateRange = '{{ dateRange }}'
AND dateStart = '{{ dateStart }}'
AND dateEnd = '{{ dateEnd }}'
AND asn = '{{ asn }}'
AND location = '{{ location }}'
AND continent = '{{ continent }}'
AND crawlPurpose = '{{ crawlPurpose }}'
AND userAgent = '{{ userAgent }}'
AND vertical = '{{ vertical }}'
AND industry = '{{ industry }}'
AND contentType = '{{ contentType }}'
AND responseStatus = '{{ responseStatus }}'
AND responseStatusCategory = '{{ responseStatusCategory }}'
AND limitPerGroup = '{{ limitPerGroup }}'
AND format = '{{ format }}'
;

list_by_user_agent

Retrieves the distribution of traffic by AI user agent.

SELECT
meta,
summary_0
FROM cloudflare.radar.ai_bots_summary
WHERE name = '{{ name }}'
AND dateRange = '{{ dateRange }}'
AND dateStart = '{{ dateStart }}'
AND dateEnd = '{{ dateEnd }}'
AND asn = '{{ asn }}'
AND location = '{{ location }}'
AND continent = '{{ continent }}'
AND limitPerGroup = '{{ limitPerGroup }}'
AND format = '{{ format }}'
;