--- title: Get email security summary by dimension --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Radar](https://developers.cloudflare.com/api/typescript/resources/radar) [Email](https://developers.cloudflare.com/api/typescript/resources/radar/subresources/email) [Security](https://developers.cloudflare.com/api/typescript/resources/radar/subresources/email/subresources/security) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get email security summary by dimension client.radar.email.security.summaryV2("SPAM"| "MALICIOUS"| "SPOOF"| 6 moredimension, SecuritySummaryV2Params {arc, dateEnd, dateRange, 8 more } query?, RequestOptionsoptions?): [SecuritySummaryV2Response]() {meta, summary\_0 } GET/radar/email/security/summary/{dimension} Retrieves the distribution of email security metrics by the specified dimension. ##### Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

##### Accepted Permissions (at least one required) `User Details Write``User Details Read` ##### ParametersExpand Collapse

dimension: "SPAM"| "MALICIOUS"| "SPOOF"| 6 more Specifies the attribute by which to group the results.

One of the following: "SPAM" Link to this property "MALICIOUS" Link to this property "SPOOF" Link to this property "THREAT\_CATEGORY" Link to this property "ARC" Link to this property "DKIM" Link to this property "DMARC" Link to this property "SPF" Link to this property "TLS\_VERSION" Link to this property

[Link to this property](<#(resource)%20radar.email.security%20%3E%20(method)%20summary_v2%20%3E%20(params)%20default%20%3E%20(param)%20dimension%20%3E%20(schema)>)

query: SecuritySummaryV2Params {arc, dateEnd, dateRange, 8 more }

arc?: Array<"PASS"| "NONE"| "FAIL"> Filters results by ARC (Authenticated Received Chain) validation.

One of the following: "PASS" Link to this property "NONE" Link to this property "FAIL" Link to this property

Link to this property dateEnd?: Array<string> 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. Link to this property dateRange?: Array<string> 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). Link to this property dateStart?: Array<string> 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. Link to this property

dkim?: Array<"PASS"| "NONE"| "FAIL"> Filters results by DKIM (DomainKeys Identified Mail) validation status.

One of the following: "PASS" Link to this property "NONE" Link to this property "FAIL" Link to this property

Link to this property

dmarc?: Array<"PASS"| "NONE"| "FAIL"> Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

One of the following: "PASS" Link to this property "NONE" Link to this property "FAIL" Link to this property

Link to this property

format?: "JSON"| "CSV" Format in which results will be returned.

One of the following: "JSON" Link to this property "CSV" Link to this property

Link to this property limitPerGroup?: number 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. Link to this property name?: Array<string> Array of names used to label the series in the response. Link to this property

spf?: Array<"PASS"| "NONE"| "FAIL"> Filters results by SPF (Sender Policy Framework) validation status.

One of the following: "PASS" Link to this property "NONE" Link to this property "FAIL" Link to this property

Link to this property

tlsVersion?: Array<"TLSv1\_0"| "TLSv1\_1"| "TLSv1\_2"| "TLSv1\_3"> Filters results by TLS version.

One of the following: "TLSv1\_0" Link to this property "TLSv1\_1" Link to this property "TLSv1\_2" Link to this property "TLSv1\_3" Link to this property

Link to this property

[Link to this property](<#(resource)%20radar.email.security%20%3E%20(method)%20summary_v2%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse

SecuritySummaryV2Response {meta, summary\_0 }

meta: Meta {confidenceInfo, dateRange, lastUpdated, 2 more } Metadata for the results.

confidenceInfo: ConfidenceInfo {annotations, level }

annotations: Array<Annotation>

dataSource: "ALL"| "AI\_BOTS"| "AI\_GATEWAY"| 22 more Data source for annotations.

Link to this property description: string Link to this property endDate: string formatdate-time Link to this property

eventType: "GENERAL"| "OUTAGE"| "PARTIAL\_PROJECTION"| 2 more Event type for annotations.

One of the following: "GENERAL" Link to this property "OUTAGE" Link to this property "PARTIAL\_PROJECTION" Link to this property "PIPELINE" Link to this property "TRAFFIC\_ANOMALY" Link to this property

Link to this property isInstantaneous: boolean Whether event is a single point in time or a time range. Link to this property linkedUrl: string formaturi Link to this property startDate: string formatdate-time Link to this property tags?: Array<string> Link to this property

Link to this property level: number Provides an indication of how much confidence Cloudflare has in the data. Link to this property

Link to this property

dateRange: Array<DateRange>

endTime: string Adjusted end of date range. formatdate-time Link to this property startTime: string Adjusted start of date range. formatdate-time Link to this property

Link to this property lastUpdated: string Timestamp of the last dataset update. formatdate-time Link to this property

normalization: "PERCENTAGE"| "MIN0\_MAX"| "MIN\_MAX"| 5 more Normalization method applied to the results. Refer to Normalization methods.

One of the following: "PERCENTAGE" Link to this property "MIN0\_MAX" Link to this property "MIN\_MAX" Link to this property "RAW\_VALUES" Link to this property "PERCENTAGE\_CHANGE" Link to this property "ROLLING\_AVERAGE" Link to this property "OVERLAPPED\_PERCENTAGE" Link to this property "RATIO" Link to this property

Link to this property

units: Array<Unit> Measurement units for the results.

name: string Link to this property value: string Link to this property

Link to this property

Link to this property summary\_0: Record<string, string> Link to this property

[Link to this property](<#(resource)%20radar.email.security%20%3E%20(model)%20security_summary_v2_response%20%3E%20(schema)>) ### Get email security summary by dimension TypeScript HTTPTypeScriptPythonGoTerraform ``` import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const response = await client.radar.email.security.summaryV2('SPAM'); console.log(response.meta); ``` 200 example ``` { "result": { "meta": { "confidenceInfo": { "annotations": [ { "dataSource": "ALL", "description": "Cable cut in Tonga", "endDate": "2019-12-27T18:11:19.117Z", "eventType": "GENERAL", "isInstantaneous": true, "linkedUrl": "https://example.com", "startDate": "2019-12-27T18:11:19.117Z", "tags": [ "BOT_CLASS" ] } ], "level": 0 }, "dateRange": [ { "endTime": "2022-09-17T10:22:57.555Z", "startTime": "2022-09-16T10:22:57.555Z" } ], "lastUpdated": "2019-12-27T18:11:19.117Z", "normalization": "PERCENTAGE", "units": [ { "name": "*", "value": "requests" } ] }, "summary_0": { "FAIL": "25.084366", "PASS": "50.168733" } }, "success": true } ``` ##### Returns Examples 200 example ``` { "result": { "meta": { "confidenceInfo": { "annotations": [ { "dataSource": "ALL", "description": "Cable cut in Tonga", "endDate": "2019-12-27T18:11:19.117Z", "eventType": "GENERAL", "isInstantaneous": true, "linkedUrl": "https://example.com", "startDate": "2019-12-27T18:11:19.117Z", "tags": [ "BOT_CLASS" ] } ], "level": 0 }, "dateRange": [ { "endTime": "2022-09-17T10:22:57.555Z", "startTime": "2022-09-16T10:22:57.555Z" } ], "lastUpdated": "2019-12-27T18:11:19.117Z", "normalization": "PERCENTAGE", "units": [ { "name": "*", "value": "requests" } ] }, "summary_0": { "FAIL": "25.084366", "PASS": "50.168733" } }, "success": true } ```