crawlers_summary
Creates, updates, deletes, gets or lists a crawlers_summary resource.
Overview
| Name | crawlers_summary |
| Type | Resource |
| Id | cloudflare.radar.crawlers_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 |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | dimension | name, dateRange, dateStart, dateEnd, limitPerGroup, botOperator, vertical, industry, clientType, responseStatus, responseStatusCategory, format | Retrieves an aggregated summary of HTTP requests from crawlers, grouped by the specified dimension. |
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. |
botOperator | array | Filters results by bot operator. |
clientType | array | Filters results by agent type. |
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. |
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. |
vertical | array | Filters results by vertical. |
SELECT examples
- get
Retrieves an aggregated summary of HTTP requests from crawlers, grouped by the specified dimension.
SELECT
meta,
summary_0
FROM cloudflare.radar.crawlers_summary
WHERE dimension = '{{ dimension }}' -- required
AND name = '{{ name }}'
AND dateRange = '{{ dateRange }}'
AND dateStart = '{{ dateStart }}'
AND dateEnd = '{{ dateEnd }}'
AND limitPerGroup = '{{ limitPerGroup }}'
AND botOperator = '{{ botOperator }}'
AND vertical = '{{ vertical }}'
AND industry = '{{ industry }}'
AND clientType = '{{ clientType }}'
AND responseStatus = '{{ responseStatus }}'
AND responseStatusCategory = '{{ responseStatusCategory }}'
AND format = '{{ format }}'
;