GET /radar/bots/summary/{dimension}

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

Servers

https://api.cloudflare.com/client/v4

Path parameters

Name Type Required Description

dimension

String

Yes

Specifies the attribute by which to group the results.

Valid values:

"BOT"
"BOT_KIND"
"BOT_OPERATOR"
"BOT_CATEGORY"

Query parameters

Name	Type	Required	Description
`botKind[]`	Array	No	Filters results by bot kind. Deprecated: the Verified Bot / Signed Agent distinction is being removed.
`dateEnd[]`	Array	No	End of the date range (inclusive). Alternative to `dateRange`; provide together with `dateStart`. When requesting comparison series, every series must resolve to the same duration as the main series. Each `dateStart`/`dateEnd` is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
`location[]`	Array	No	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.
`dateStart[]`	Array	No	Start of the date range. Alternative to `dateRange`; provide together with `dateEnd`. When requesting comparison series, every series must resolve to the same duration as the main series. Each `dateStart`/`dateEnd` is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
`botOperator[]`	Array	No	Filters results by bot operator.
`limitPerGroup`	Integer	No	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. Only supported on high-cardinality dimensions; otherwise the request is rejected. Minimum value is 2.
`dateRange[]`	Array	No	Filters results by relative date range ending at the current time, with each value producing a separate series. Use `<n>d` for days (up to `364d`) or `<n>w` for weeks (up to `52w`). Append `control` to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. `7dcontrol` covers days -14 to -7, `10dcontrol` covers days -24 to -14). For example, pass `7d` and `7dcontrol` to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including `control`) satisfy this automatically. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).
`asn[]`	Array	No	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.
`name[]`	Array	No	Array of names used to label the series in the response.
`botVerificationStatus[]`	Array	No	Filters results by bot verification status (Verified vs. Unverified).
`format`	String	No	Format in which results will be returned. Valid values: `"CSV"` `"JSON"`
`botCategory[]`	Array	No	Filters results by bot category.
`continent[]`	Array	No	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.
`bot[]`	Array	No	Filters results by bot name.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.