locations_bot_class
Creates, updates, deletes, gets or lists a locations_bot_class resource.
Overview
| Name | locations_bot_class |
| Type | Resource |
| Id | cloudflare.radar.locations_bot_class |
Fields
The following fields are returned by SELECT queries:
- get
Successful response.
| Name | Datatype | Description |
|---|---|---|
meta | object | Metadata for the results. |
top_0 | array |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | bot_class | limit, name, dateRange, dateStart, dateEnd, asn, location, continent, geoId, deviceType, httpProtocol, httpVersion, ipVersion, os, tlsVersion, browserFamily, format | Retrieves the top locations, by HTTP requests, of the requested bot class. |
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 |
|---|---|---|
bot_class | string | Bot class. Refer to Bot classes. |
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. |
browserFamily | array | Filters results by browser family. |
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. |
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. |
deviceType | array | Filters results by device type. |
format | string | Format in which results will be returned. |
geoId | array | 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 | Filters results by HTTP protocol (HTTP vs. HTTPS). |
httpVersion | array | Filters results by HTTP version. |
ipVersion | array | Filters results by IP version (Ipv4 vs. IPv6). |
limit | integer | Limits the number of objects returned in the response. |
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. |
os | array | Filters results by operating system. |
tlsVersion | array | Filters results by TLS version. |
SELECT examples
- get
Retrieves the top locations, by HTTP requests, of the requested bot class.
SELECT
meta,
top_0
FROM cloudflare.radar.locations_bot_class
WHERE bot_class = '{{ bot_class }}' -- required
AND limit = '{{ limit }}'
AND name = '{{ name }}'
AND dateRange = '{{ dateRange }}'
AND dateStart = '{{ dateStart }}'
AND dateEnd = '{{ dateEnd }}'
AND asn = '{{ asn }}'
AND location = '{{ location }}'
AND continent = '{{ continent }}'
AND geoId = '{{ geoId }}'
AND deviceType = '{{ deviceType }}'
AND httpProtocol = '{{ httpProtocol }}'
AND httpVersion = '{{ httpVersion }}'
AND ipVersion = '{{ ipVersion }}'
AND os = '{{ os }}'
AND tlsVersion = '{{ tlsVersion }}'
AND browserFamily = '{{ browserFamily }}'
AND format = '{{ format }}'
;