{"command":{"effect":"read","timeoutSeconds":30,"inputSchema":{"type":"object","description":"Retrieves the distribution of email security metrics by the specified dimension.","properties":{"path":{"type":"object","properties":{"dimension":{"description":"Specifies the attribute by which to group the results.","type":"string","enum":["SPAM","MALICIOUS","SPOOF","THREAT_CATEGORY","ARC","DKIM","DMARC","SPF","TLS_VERSION"]}},"required":["dimension"],"additionalProperties":false},"query":{"type":"object","properties":{"name":{"description":"Array of names used to label the series in the response.","type":"array","items":{"type":"string","examples":["main_series"]}},"dateRange":{"description":"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).","type":"array","items":{"pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string","examples":["7d"]},"examples":["7d"]},"dateStart":{"description":"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.","type":"array","items":{"format":"date-time","type":"string"},"examples":["2023-09-01T11:41:33.782Z"]},"dateEnd":{"description":"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.","type":"array","items":{"format":"date-time","type":"string"},"examples":["2023-09-01T11:41:33.782Z"]},"arc":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","type":"array","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"examples":["PASS"]},"dkim":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","type":"array","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"examples":["PASS"]},"dmarc":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","type":"array","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"examples":["PASS"]},"spf":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","type":"array","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"examples":["PASS"]},"tlsVersion":{"description":"Filters results by TLS version.","type":"array","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"type":"string"},"examples":["TLSv1_2"]},"limitPerGroup":{"description":"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.","type":"integer","examples":[10]},"format":{"description":"Format in which results will be returned.","type":"string","enum":["JSON","CSV"],"examples":["json"]}},"required":[],"additionalProperties":false}},"required":["path"],"additionalProperties":false},"name":"Get email security summary by dimension","id":"cloudflare.radar-get-email-security-summary","example":{"path":{"dimension":"SPAM"}},"maxRequests":1,"summary":false}}