GET /radar/email/security/summary/{dimension}
Retrieves the distribution of email security metrics 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:
|
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
name[] |
Array | No |
Array of names used to label the series in the response. |
format |
String | No |
Format in which results will be returned. Valid values:
|
dateEnd[] |
Array | No |
End of the date range (inclusive). Alternative to |
arc[] |
Array | No |
Filters results by ARC (Authenticated Received Chain) validation. |
dateStart[] |
Array | No |
Start of the date range. Alternative to |
tlsVersion[] |
Array | No |
Filters results by TLS version. |
dmarc[] |
Array | No |
Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. |
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 |
dkim[] |
Array | No |
Filters results by DKIM (DomainKeys Identified Mail) validation status. |
spf[] |
Array | No |
Filters results by SPF (Sender Policy Framework) validation status. |
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.