security_summary
Creates, updates, deletes, gets or lists a security_summary resource.
Overview
| Name | security_summary |
| Type | Resource |
| Id | cloudflare.radar.security_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, arc, dkim, dmarc, spf, tlsVersion, limitPerGroup, format | Retrieves the distribution of email security metrics 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. |
arc | array | Filters results by ARC (Authenticated Received Chain) validation. |
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. |
dkim | array | Filters results by DKIM (DomainKeys Identified Mail) validation status. |
dmarc | array | Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. |
format | string | Format in which results will be returned. |
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. |
spf | array | Filters results by SPF (Sender Policy Framework) validation status. |
tlsVersion | array | Filters results by TLS version. |
SELECT examples
- get
Retrieves the distribution of email security metrics by the specified dimension.
SELECT
meta,
summary_0
FROM cloudflare.radar.security_summary
WHERE dimension = '{{ dimension }}' -- required
AND name = '{{ name }}'
AND dateRange = '{{ dateRange }}'
AND dateStart = '{{ dateStart }}'
AND dateEnd = '{{ dateEnd }}'
AND arc = '{{ arc }}'
AND dkim = '{{ dkim }}'
AND dmarc = '{{ dmarc }}'
AND spf = '{{ spf }}'
AND tlsVersion = '{{ tlsVersion }}'
AND limitPerGroup = '{{ limitPerGroup }}'
AND format = '{{ format }}'
;