# Email

## Domain Types

### Radar Email Series

- `RadarEmailSeries`

  - `FAIL: Array<string>`

  - `NONE: Array<string>`

  - `PASS: Array<string>`

### Radar Email Summary

- `RadarEmailSummary`

  - `FAIL: string`

    A numeric string.

  - `NONE: string`

    A numeric string.

  - `PASS: string`

    A numeric string.

# Routing

## Get email routing summary by dimension

`client.radar.email.routing.summaryV2("IP_VERSION" | "ENCRYPTED" | "ARC" | 3 moredimension, RoutingSummaryV2Paramsquery?, RequestOptionsoptions?): RoutingSummaryV2Response`

**get** `/radar/email/routing/summary/{dimension}`

Retrieves the distribution of email routing metrics by the specified dimension.

### Parameters

- `dimension: "IP_VERSION" | "ENCRYPTED" | "ARC" | 3 more`

  Specifies the attribute by which to group the results.

  - `"IP_VERSION"`

  - `"ENCRYPTED"`

  - `"ARC"`

  - `"DKIM"`

  - `"DMARC"`

  - `"SPF"`

- `query: RoutingSummaryV2Params`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `encrypted?: Array<"ENCRYPTED" | "NOT_ENCRYPTED">`

    Filters results by encryption status (encrypted vs. not-encrypted).

    - `"ENCRYPTED"`

    - `"NOT_ENCRYPTED"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `ipVersion?: Array<"IPv4" | "IPv6">`

    Filters results by IP version (Ipv4 vs. IPv6).

    - `"IPv4"`

    - `"IPv6"`

  - `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.

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

### Returns

- `RoutingSummaryV2Response`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: Record<string, string>`

### Example

```typescript
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.routing.summaryV2('IP_VERSION');

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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
}
```

## Get email routing time series grouped by dimension

`client.radar.email.routing.timeseriesGroupsV2("IP_VERSION" | "ENCRYPTED" | "ARC" | 3 moredimension, RoutingTimeseriesGroupsV2Paramsquery?, RequestOptionsoptions?): RoutingTimeseriesGroupsV2Response`

**get** `/radar/email/routing/timeseries_groups/{dimension}`

Retrieves the distribution of email routing metrics grouped by dimension over time.

### Parameters

- `dimension: "IP_VERSION" | "ENCRYPTED" | "ARC" | 3 more`

  Specifies the attribute by which to group the results.

  - `"IP_VERSION"`

  - `"ENCRYPTED"`

  - `"ARC"`

  - `"DKIM"`

  - `"DMARC"`

  - `"SPF"`

- `query: RoutingTimeseriesGroupsV2Params`

  - `aggInterval?: "15m" | "1h" | "1d" | "1w"`

    Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/). When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected.

    - `"15m"`

    - `"1h"`

    - `"1d"`

    - `"1w"`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `encrypted?: Array<"ENCRYPTED" | "NOT_ENCRYPTED">`

    Filters results by encryption status (encrypted vs. not-encrypted).

    - `"ENCRYPTED"`

    - `"NOT_ENCRYPTED"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `ipVersion?: Array<"IPv4" | "IPv6">`

    Filters results by IP version (Ipv4 vs. IPv6).

    - `"IPv4"`

    - `"IPv6"`

  - `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.

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

### Returns

- `RoutingTimeseriesGroupsV2Response`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: Serie0`

    - `timestamps: Array<string>`

### Example

```typescript
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.routing.timeseriesGroupsV2('IP_VERSION');

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "aggInterval": "FIFTEEN_MINUTES",
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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"
        }
      ]
    },
    "serie_0": {
      "timestamps": [
        "2023-08-08T10:15:00Z"
      ]
    }
  },
  "success": true
}
```

## Domain Types

### Routing Summary V2 Response

- `RoutingSummaryV2Response`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: Record<string, string>`

### Routing Timeseries Groups V2 Response

- `RoutingTimeseriesGroupsV2Response`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: Serie0`

    - `timestamps: Array<string>`

# Summary

## Get email ARC validation summary

`client.radar.email.routing.summary.arc(SummaryARCParamsquery?, RequestOptionsoptions?): SummaryARCResponse`

**get** `/radar/email/routing/summary/arc`

Retrieves the distribution of emails by ARC (Authenticated Received Chain) validation.

### Parameters

- `query: SummaryARCParams`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `encrypted?: Array<"ENCRYPTED" | "NOT_ENCRYPTED">`

    Filters results by encryption status (encrypted vs. not-encrypted).

    - `"ENCRYPTED"`

    - `"NOT_ENCRYPTED"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `ipVersion?: Array<"IPv4" | "IPv6">`

    Filters results by IP version (Ipv4 vs. IPv6).

    - `"IPv4"`

    - `"IPv6"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

### Returns

- `SummaryARCResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: RadarEmailSummary`

    - `FAIL: string`

      A numeric string.

    - `NONE: string`

      A numeric string.

    - `PASS: string`

      A numeric string.

### Example

```typescript
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.routing.summary.arc();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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": "10",
      "NONE": "10",
      "PASS": "10"
    }
  },
  "success": true
}
```

## Get email DKIM validation summary

`client.radar.email.routing.summary.dkim(SummaryDKIMParamsquery?, RequestOptionsoptions?): SummaryDKIMResponse`

**get** `/radar/email/routing/summary/dkim`

Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) validation.

### Parameters

- `query: SummaryDKIMParams`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `encrypted?: Array<"ENCRYPTED" | "NOT_ENCRYPTED">`

    Filters results by encryption status (encrypted vs. not-encrypted).

    - `"ENCRYPTED"`

    - `"NOT_ENCRYPTED"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `ipVersion?: Array<"IPv4" | "IPv6">`

    Filters results by IP version (Ipv4 vs. IPv6).

    - `"IPv4"`

    - `"IPv6"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

### Returns

- `SummaryDKIMResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: RadarEmailSummary`

    - `FAIL: string`

      A numeric string.

    - `NONE: string`

      A numeric string.

    - `PASS: string`

      A numeric string.

### Example

```typescript
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.routing.summary.dkim();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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": "10",
      "NONE": "10",
      "PASS": "10"
    }
  },
  "success": true
}
```

## Get email DMARC validation summary

`client.radar.email.routing.summary.dmarc(SummaryDMARCParamsquery?, RequestOptionsoptions?): SummaryDMARCResponse`

**get** `/radar/email/routing/summary/dmarc`

Retrieves the distribution of emails by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation.

### Parameters

- `query: SummaryDMARCParams`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `encrypted?: Array<"ENCRYPTED" | "NOT_ENCRYPTED">`

    Filters results by encryption status (encrypted vs. not-encrypted).

    - `"ENCRYPTED"`

    - `"NOT_ENCRYPTED"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `ipVersion?: Array<"IPv4" | "IPv6">`

    Filters results by IP version (Ipv4 vs. IPv6).

    - `"IPv4"`

    - `"IPv6"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

### Returns

- `SummaryDMARCResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: RadarEmailSummary`

    - `FAIL: string`

      A numeric string.

    - `NONE: string`

      A numeric string.

    - `PASS: string`

      A numeric string.

### Example

```typescript
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.routing.summary.dmarc();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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": "10",
      "NONE": "10",
      "PASS": "10"
    }
  },
  "success": true
}
```

## Get email encryption status summary

`client.radar.email.routing.summary.encrypted(SummaryEncryptedParamsquery?, RequestOptionsoptions?): SummaryEncryptedResponse`

**get** `/radar/email/routing/summary/encrypted`

Retrieves the distribution of emails by encryption status (encrypted vs. not-encrypted).

### Parameters

- `query: SummaryEncryptedParams`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `ipVersion?: Array<"IPv4" | "IPv6">`

    Filters results by IP version (Ipv4 vs. IPv6).

    - `"IPv4"`

    - `"IPv6"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

### Returns

- `SummaryEncryptedResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: Summary0`

    - `ENCRYPTED: string`

      A numeric string.

    - `NOT_ENCRYPTED: string`

      A numeric string.

### Example

```typescript
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.routing.summary.encrypted();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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": {
      "ENCRYPTED": "10",
      "NOT_ENCRYPTED": "10"
    }
  },
  "success": true
}
```

## Get email IP version summary

`client.radar.email.routing.summary.ipVersion(SummaryIPVersionParamsquery?, RequestOptionsoptions?): SummaryIPVersionResponse`

**get** `/radar/email/routing/summary/ip_version`

Retrieves the distribution of emails by IP version.

### Parameters

- `query: SummaryIPVersionParams`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `encrypted?: Array<"ENCRYPTED" | "NOT_ENCRYPTED">`

    Filters results by encryption status (encrypted vs. not-encrypted).

    - `"ENCRYPTED"`

    - `"NOT_ENCRYPTED"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

### Returns

- `SummaryIPVersionResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: Summary0`

    - `IPv4: string`

      A numeric string.

    - `IPv6: string`

      A numeric string.

### Example

```typescript
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.routing.summary.ipVersion();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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": {
      "IPv4": "10",
      "IPv6": "10"
    }
  },
  "success": true
}
```

## Get email SPF validation summary

`client.radar.email.routing.summary.spf(SummarySPFParamsquery?, RequestOptionsoptions?): SummarySPFResponse`

**get** `/radar/email/routing/summary/spf`

Retrieves the distribution of emails by SPF (Sender Policy Framework) validation.

### Parameters

- `query: SummarySPFParams`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `encrypted?: Array<"ENCRYPTED" | "NOT_ENCRYPTED">`

    Filters results by encryption status (encrypted vs. not-encrypted).

    - `"ENCRYPTED"`

    - `"NOT_ENCRYPTED"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `ipVersion?: Array<"IPv4" | "IPv6">`

    Filters results by IP version (Ipv4 vs. IPv6).

    - `"IPv4"`

    - `"IPv6"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

### Returns

- `SummarySPFResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: RadarEmailSummary`

    - `FAIL: string`

      A numeric string.

    - `NONE: string`

      A numeric string.

    - `PASS: string`

      A numeric string.

### Example

```typescript
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.routing.summary.spf();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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": "10",
      "NONE": "10",
      "PASS": "10"
    }
  },
  "success": true
}
```

## Domain Types

### Summary ARC Response

- `SummaryARCResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: RadarEmailSummary`

    - `FAIL: string`

      A numeric string.

    - `NONE: string`

      A numeric string.

    - `PASS: string`

      A numeric string.

### Summary DKIM Response

- `SummaryDKIMResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: RadarEmailSummary`

    - `FAIL: string`

      A numeric string.

    - `NONE: string`

      A numeric string.

    - `PASS: string`

      A numeric string.

### Summary DMARC Response

- `SummaryDMARCResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: RadarEmailSummary`

    - `FAIL: string`

      A numeric string.

    - `NONE: string`

      A numeric string.

    - `PASS: string`

      A numeric string.

### Summary Encrypted Response

- `SummaryEncryptedResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: Summary0`

    - `ENCRYPTED: string`

      A numeric string.

    - `NOT_ENCRYPTED: string`

      A numeric string.

### Summary IP Version Response

- `SummaryIPVersionResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: Summary0`

    - `IPv4: string`

      A numeric string.

    - `IPv6: string`

      A numeric string.

### Summary SPF Response

- `SummarySPFResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: RadarEmailSummary`

    - `FAIL: string`

      A numeric string.

    - `NONE: string`

      A numeric string.

    - `PASS: string`

      A numeric string.

# Timeseries Groups

## Get email ARC validation time series

`client.radar.email.routing.timeseriesGroups.arc(TimeseriesGroupARCParamsquery?, RequestOptionsoptions?): TimeseriesGroupARCResponse`

**get** `/radar/email/routing/timeseries_groups/arc`

Retrieves the distribution of emails by ARC (Authenticated Received Chain) validation over time.

### Parameters

- `query: TimeseriesGroupARCParams`

  - `aggInterval?: "15m" | "1h" | "1d" | "1w"`

    Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/). When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected.

    - `"15m"`

    - `"1h"`

    - `"1d"`

    - `"1w"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `encrypted?: Array<"ENCRYPTED" | "NOT_ENCRYPTED">`

    Filters results by encryption status (encrypted vs. not-encrypted).

    - `"ENCRYPTED"`

    - `"NOT_ENCRYPTED"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `ipVersion?: Array<"IPv4" | "IPv6">`

    Filters results by IP version (Ipv4 vs. IPv6).

    - `"IPv4"`

    - `"IPv6"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

### Returns

- `TimeseriesGroupARCResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: RadarEmailSeries`

    - `FAIL: Array<string>`

    - `NONE: Array<string>`

    - `PASS: Array<string>`

### Example

```typescript
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.routing.timeseriesGroups.arc();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "aggInterval": "FIFTEEN_MINUTES",
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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"
        }
      ]
    },
    "serie_0": {
      "FAIL": [
        "10"
      ],
      "NONE": [
        "10"
      ],
      "PASS": [
        "10"
      ]
    }
  },
  "success": true
}
```

## Get email DKIM validation time series

`client.radar.email.routing.timeseriesGroups.dkim(TimeseriesGroupDKIMParamsquery?, RequestOptionsoptions?): TimeseriesGroupDKIMResponse`

**get** `/radar/email/routing/timeseries_groups/dkim`

Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) validation over time.

### Parameters

- `query: TimeseriesGroupDKIMParams`

  - `aggInterval?: "15m" | "1h" | "1d" | "1w"`

    Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/). When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected.

    - `"15m"`

    - `"1h"`

    - `"1d"`

    - `"1w"`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `encrypted?: Array<"ENCRYPTED" | "NOT_ENCRYPTED">`

    Filters results by encryption status (encrypted vs. not-encrypted).

    - `"ENCRYPTED"`

    - `"NOT_ENCRYPTED"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `ipVersion?: Array<"IPv4" | "IPv6">`

    Filters results by IP version (Ipv4 vs. IPv6).

    - `"IPv4"`

    - `"IPv6"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

### Returns

- `TimeseriesGroupDKIMResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: RadarEmailSeries`

    - `FAIL: Array<string>`

    - `NONE: Array<string>`

    - `PASS: Array<string>`

### Example

```typescript
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.routing.timeseriesGroups.dkim();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "aggInterval": "FIFTEEN_MINUTES",
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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"
        }
      ]
    },
    "serie_0": {
      "FAIL": [
        "10"
      ],
      "NONE": [
        "10"
      ],
      "PASS": [
        "10"
      ]
    }
  },
  "success": true
}
```

## Get email DMARC validation time series

`client.radar.email.routing.timeseriesGroups.dmarc(TimeseriesGroupDMARCParamsquery?, RequestOptionsoptions?): TimeseriesGroupDMARCResponse`

**get** `/radar/email/routing/timeseries_groups/dmarc`

Retrieves the distribution of emails by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation over time.

### Parameters

- `query: TimeseriesGroupDMARCParams`

  - `aggInterval?: "15m" | "1h" | "1d" | "1w"`

    Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/). When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected.

    - `"15m"`

    - `"1h"`

    - `"1d"`

    - `"1w"`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `encrypted?: Array<"ENCRYPTED" | "NOT_ENCRYPTED">`

    Filters results by encryption status (encrypted vs. not-encrypted).

    - `"ENCRYPTED"`

    - `"NOT_ENCRYPTED"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `ipVersion?: Array<"IPv4" | "IPv6">`

    Filters results by IP version (Ipv4 vs. IPv6).

    - `"IPv4"`

    - `"IPv6"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

### Returns

- `TimeseriesGroupDMARCResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: RadarEmailSeries`

    - `FAIL: Array<string>`

    - `NONE: Array<string>`

    - `PASS: Array<string>`

### Example

```typescript
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.routing.timeseriesGroups.dmarc();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "aggInterval": "FIFTEEN_MINUTES",
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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"
        }
      ]
    },
    "serie_0": {
      "FAIL": [
        "10"
      ],
      "NONE": [
        "10"
      ],
      "PASS": [
        "10"
      ]
    }
  },
  "success": true
}
```

## Get email encryption status time series

`client.radar.email.routing.timeseriesGroups.encrypted(TimeseriesGroupEncryptedParamsquery?, RequestOptionsoptions?): TimeseriesGroupEncryptedResponse`

**get** `/radar/email/routing/timeseries_groups/encrypted`

Retrieves the distribution of emails by encryption status (encrypted vs. not-encrypted) over time.

### Parameters

- `query: TimeseriesGroupEncryptedParams`

  - `aggInterval?: "15m" | "1h" | "1d" | "1w"`

    Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/). When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected.

    - `"15m"`

    - `"1h"`

    - `"1d"`

    - `"1w"`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `ipVersion?: Array<"IPv4" | "IPv6">`

    Filters results by IP version (Ipv4 vs. IPv6).

    - `"IPv4"`

    - `"IPv6"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

### Returns

- `TimeseriesGroupEncryptedResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: Serie0`

    - `ENCRYPTED: Array<string>`

    - `NOT_ENCRYPTED: Array<string>`

### Example

```typescript
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.routing.timeseriesGroups.encrypted();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "aggInterval": "FIFTEEN_MINUTES",
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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"
        }
      ]
    },
    "serie_0": {
      "ENCRYPTED": [
        "10"
      ],
      "NOT_ENCRYPTED": [
        "10"
      ]
    }
  },
  "success": true
}
```

## Get email IP version time series

`client.radar.email.routing.timeseriesGroups.ipVersion(TimeseriesGroupIPVersionParamsquery?, RequestOptionsoptions?): TimeseriesGroupIPVersionResponse`

**get** `/radar/email/routing/timeseries_groups/ip_version`

Retrieves the distribution of emails by IP version over time.

### Parameters

- `query: TimeseriesGroupIPVersionParams`

  - `aggInterval?: "15m" | "1h" | "1d" | "1w"`

    Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/). When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected.

    - `"15m"`

    - `"1h"`

    - `"1d"`

    - `"1w"`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `encrypted?: Array<"ENCRYPTED" | "NOT_ENCRYPTED">`

    Filters results by encryption status (encrypted vs. not-encrypted).

    - `"ENCRYPTED"`

    - `"NOT_ENCRYPTED"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

### Returns

- `TimeseriesGroupIPVersionResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: Serie0`

    - `IPv4: Array<string>`

    - `IPv6: Array<string>`

### Example

```typescript
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.routing.timeseriesGroups.ipVersion();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "aggInterval": "FIFTEEN_MINUTES",
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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"
        }
      ]
    },
    "serie_0": {
      "IPv4": [
        "10"
      ],
      "IPv6": [
        "10"
      ]
    }
  },
  "success": true
}
```

## Get email SPF validation time series

`client.radar.email.routing.timeseriesGroups.spf(TimeseriesGroupSPFParamsquery?, RequestOptionsoptions?): TimeseriesGroupSPFResponse`

**get** `/radar/email/routing/timeseries_groups/spf`

Retrieves the distribution of emails by SPF (Sender Policy Framework) validation over time.

### Parameters

- `query: TimeseriesGroupSPFParams`

  - `aggInterval?: "15m" | "1h" | "1d" | "1w"`

    Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/). When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected.

    - `"15m"`

    - `"1h"`

    - `"1d"`

    - `"1w"`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `encrypted?: Array<"ENCRYPTED" | "NOT_ENCRYPTED">`

    Filters results by encryption status (encrypted vs. not-encrypted).

    - `"ENCRYPTED"`

    - `"NOT_ENCRYPTED"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `ipVersion?: Array<"IPv4" | "IPv6">`

    Filters results by IP version (Ipv4 vs. IPv6).

    - `"IPv4"`

    - `"IPv6"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

### Returns

- `TimeseriesGroupSPFResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: RadarEmailSeries`

    - `FAIL: Array<string>`

    - `NONE: Array<string>`

    - `PASS: Array<string>`

### Example

```typescript
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.routing.timeseriesGroups.spf();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "aggInterval": "FIFTEEN_MINUTES",
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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"
        }
      ]
    },
    "serie_0": {
      "FAIL": [
        "10"
      ],
      "NONE": [
        "10"
      ],
      "PASS": [
        "10"
      ]
    }
  },
  "success": true
}
```

## Domain Types

### Timeseries Group ARC Response

- `TimeseriesGroupARCResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: RadarEmailSeries`

    - `FAIL: Array<string>`

    - `NONE: Array<string>`

    - `PASS: Array<string>`

### Timeseries Group DKIM Response

- `TimeseriesGroupDKIMResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: RadarEmailSeries`

    - `FAIL: Array<string>`

    - `NONE: Array<string>`

    - `PASS: Array<string>`

### Timeseries Group DMARC Response

- `TimeseriesGroupDMARCResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: RadarEmailSeries`

    - `FAIL: Array<string>`

    - `NONE: Array<string>`

    - `PASS: Array<string>`

### Timeseries Group Encrypted Response

- `TimeseriesGroupEncryptedResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: Serie0`

    - `ENCRYPTED: Array<string>`

    - `NOT_ENCRYPTED: Array<string>`

### Timeseries Group IP Version Response

- `TimeseriesGroupIPVersionResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: Serie0`

    - `IPv4: Array<string>`

    - `IPv6: Array<string>`

### Timeseries Group SPF Response

- `TimeseriesGroupSPFResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: RadarEmailSeries`

    - `FAIL: Array<string>`

    - `NONE: Array<string>`

    - `PASS: Array<string>`

# Security

## Get email security summary by dimension

`client.radar.email.security.summaryV2("SPAM" | "MALICIOUS" | "SPOOF" | 6 moredimension, SecuritySummaryV2Paramsquery?, RequestOptionsoptions?): SecuritySummaryV2Response`

**get** `/radar/email/security/summary/{dimension}`

Retrieves the distribution of email security metrics by the specified dimension.

### Parameters

- `dimension: "SPAM" | "MALICIOUS" | "SPOOF" | 6 more`

  Specifies the attribute by which to group the results.

  - `"SPAM"`

  - `"MALICIOUS"`

  - `"SPOOF"`

  - `"THREAT_CATEGORY"`

  - `"ARC"`

  - `"DKIM"`

  - `"DMARC"`

  - `"SPF"`

  - `"TLS_VERSION"`

- `query: SecuritySummaryV2Params`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `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.

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `tlsVersion?: Array<"TLSv1_0" | "TLSv1_1" | "TLSv1_2" | "TLSv1_3">`

    Filters results by TLS version.

    - `"TLSv1_0"`

    - `"TLSv1_1"`

    - `"TLSv1_2"`

    - `"TLSv1_3"`

### Returns

- `SecuritySummaryV2Response`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: Record<string, string>`

### Example

```typescript
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);
```

#### Response

```json
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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
}
```

## Get email security time series grouped by dimension

`client.radar.email.security.timeseriesGroupsV2("SPAM" | "MALICIOUS" | "SPOOF" | 6 moredimension, SecurityTimeseriesGroupsV2Paramsquery?, RequestOptionsoptions?): SecurityTimeseriesGroupsV2Response`

**get** `/radar/email/security/timeseries_groups/{dimension}`

Retrieves the distribution of email security metrics grouped by dimension over time.

### Parameters

- `dimension: "SPAM" | "MALICIOUS" | "SPOOF" | 6 more`

  Specifies the attribute by which to group the results.

  - `"SPAM"`

  - `"MALICIOUS"`

  - `"SPOOF"`

  - `"THREAT_CATEGORY"`

  - `"ARC"`

  - `"DKIM"`

  - `"DMARC"`

  - `"SPF"`

  - `"TLS_VERSION"`

- `query: SecurityTimeseriesGroupsV2Params`

  - `aggInterval?: "15m" | "1h" | "1d" | "1w"`

    Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/). When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected.

    - `"15m"`

    - `"1h"`

    - `"1d"`

    - `"1w"`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `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.

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `tlsVersion?: Array<"TLSv1_0" | "TLSv1_1" | "TLSv1_2" | "TLSv1_3">`

    Filters results by TLS version.

    - `"TLSv1_0"`

    - `"TLSv1_1"`

    - `"TLSv1_2"`

    - `"TLSv1_3"`

### Returns

- `SecurityTimeseriesGroupsV2Response`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: Serie0`

    - `timestamps: Array<string>`

### Example

```typescript
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.timeseriesGroupsV2('SPAM');

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "aggInterval": "FIFTEEN_MINUTES",
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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"
        }
      ]
    },
    "serie_0": {
      "timestamps": [
        "2023-08-08T10:15:00Z"
      ]
    }
  },
  "success": true
}
```

## Domain Types

### Security Summary V2 Response

- `SecuritySummaryV2Response`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: Record<string, string>`

### Security Timeseries Groups V2 Response

- `SecurityTimeseriesGroupsV2Response`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: Serie0`

    - `timestamps: Array<string>`

# Top

# TLDs

## Get top TLDs by email message volume

`client.radar.email.security.top.tlds.get(TLDGetParamsquery?, RequestOptionsoptions?): TLDGetResponse`

**get** `/radar/email/security/top/tlds`

Retrieves the top TLDs by number of email messages.

### Parameters

- `query: TLDGetParams`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `limit?: number`

    Limits the number of objects returned in the response.

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `tldCategory?: "CLASSIC" | "COUNTRY"`

    Filters results by TLD category.

    - `"CLASSIC"`

    - `"COUNTRY"`

  - `tlsVersion?: Array<"TLSv1_0" | "TLSv1_1" | "TLSv1_2" | "TLSv1_3">`

    Filters results by TLS version.

    - `"TLSv1_0"`

    - `"TLSv1_1"`

    - `"TLSv1_2"`

    - `"TLSv1_3"`

### Returns

- `TLDGetResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo | null`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `top_0: Array<Top0>`

    - `name: string`

    - `value: string`

      A numeric string.

### Example

```typescript
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const tld = await client.radar.email.security.top.tlds.get();

console.log(tld.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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"
        }
      ]
    },
    "top_0": [
      {
        "name": "com.",
        "value": "10"
      }
    ]
  },
  "success": true
}
```

## Domain Types

### TLD Get Response

- `TLDGetResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo | null`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `top_0: Array<Top0>`

    - `name: string`

    - `value: string`

      A numeric string.

# Malicious

## Get top TLDs by email malicious classification

`client.radar.email.security.top.tlds.malicious.get("MALICIOUS" | "NOT_MALICIOUS"malicious, MaliciousGetParamsquery?, RequestOptionsoptions?): MaliciousGetResponse`

**get** `/radar/email/security/top/tlds/malicious/{malicious}`

Retrieves the top TLDs by emails classified as malicious or not.

### Parameters

- `malicious: "MALICIOUS" | "NOT_MALICIOUS"`

  Malicious classification.

  - `"MALICIOUS"`

  - `"NOT_MALICIOUS"`

- `query: MaliciousGetParams`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `limit?: number`

    Limits the number of objects returned in the response.

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `tldCategory?: "CLASSIC" | "COUNTRY"`

    Filters results by TLD category.

    - `"CLASSIC"`

    - `"COUNTRY"`

  - `tlsVersion?: Array<"TLSv1_0" | "TLSv1_1" | "TLSv1_2" | "TLSv1_3">`

    Filters results by TLS version.

    - `"TLSv1_0"`

    - `"TLSv1_1"`

    - `"TLSv1_2"`

    - `"TLSv1_3"`

### Returns

- `MaliciousGetResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo | null`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `top_0: Array<Top0>`

    - `name: string`

    - `value: string`

      A numeric string.

### Example

```typescript
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const malicious = await client.radar.email.security.top.tlds.malicious.get('MALICIOUS');

console.log(malicious.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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"
        }
      ]
    },
    "top_0": [
      {
        "name": "com.",
        "value": "10"
      }
    ]
  },
  "success": true
}
```

## Domain Types

### Malicious Get Response

- `MaliciousGetResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo | null`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `top_0: Array<Top0>`

    - `name: string`

    - `value: string`

      A numeric string.

# Spam

## Get top TLDs by email spam classification

`client.radar.email.security.top.tlds.spam.get("SPAM" | "NOT_SPAM"spam, SpamGetParamsquery?, RequestOptionsoptions?): SpamGetResponse`

**get** `/radar/email/security/top/tlds/spam/{spam}`

Retrieves the top TLDs by emails classified as spam or not.

### Parameters

- `spam: "SPAM" | "NOT_SPAM"`

  Spam classification.

  - `"SPAM"`

  - `"NOT_SPAM"`

- `query: SpamGetParams`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `limit?: number`

    Limits the number of objects returned in the response.

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `tldCategory?: "CLASSIC" | "COUNTRY"`

    Filters results by TLD category.

    - `"CLASSIC"`

    - `"COUNTRY"`

  - `tlsVersion?: Array<"TLSv1_0" | "TLSv1_1" | "TLSv1_2" | "TLSv1_3">`

    Filters results by TLS version.

    - `"TLSv1_0"`

    - `"TLSv1_1"`

    - `"TLSv1_2"`

    - `"TLSv1_3"`

### Returns

- `SpamGetResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo | null`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `top_0: Array<Top0>`

    - `name: string`

    - `value: string`

      A numeric string.

### Example

```typescript
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const spam = await client.radar.email.security.top.tlds.spam.get('SPAM');

console.log(spam.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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"
        }
      ]
    },
    "top_0": [
      {
        "name": "com.",
        "value": "10"
      }
    ]
  },
  "success": true
}
```

## Domain Types

### Spam Get Response

- `SpamGetResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo | null`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `top_0: Array<Top0>`

    - `name: string`

    - `value: string`

      A numeric string.

# Spoof

## Get top TLDs by email spoof classification

`client.radar.email.security.top.tlds.spoof.get("SPOOF" | "NOT_SPOOF"spoof, SpoofGetParamsquery?, RequestOptionsoptions?): SpoofGetResponse`

**get** `/radar/email/security/top/tlds/spoof/{spoof}`

Retrieves the top TLDs by emails classified as spoof or not.

### Parameters

- `spoof: "SPOOF" | "NOT_SPOOF"`

  Spoof classification.

  - `"SPOOF"`

  - `"NOT_SPOOF"`

- `query: SpoofGetParams`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `limit?: number`

    Limits the number of objects returned in the response.

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `tldCategory?: "CLASSIC" | "COUNTRY"`

    Filters results by TLD category.

    - `"CLASSIC"`

    - `"COUNTRY"`

  - `tlsVersion?: Array<"TLSv1_0" | "TLSv1_1" | "TLSv1_2" | "TLSv1_3">`

    Filters results by TLS version.

    - `"TLSv1_0"`

    - `"TLSv1_1"`

    - `"TLSv1_2"`

    - `"TLSv1_3"`

### Returns

- `SpoofGetResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo | null`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `top_0: Array<Top0>`

    - `name: string`

    - `value: string`

      A numeric string.

### Example

```typescript
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const spoof = await client.radar.email.security.top.tlds.spoof.get('SPOOF');

console.log(spoof.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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"
        }
      ]
    },
    "top_0": [
      {
        "name": "com.",
        "value": "10"
      }
    ]
  },
  "success": true
}
```

## Domain Types

### Spoof Get Response

- `SpoofGetResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo | null`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `top_0: Array<Top0>`

    - `name: string`

    - `value: string`

      A numeric string.

# Summary

## Get email ARC validation summary

`client.radar.email.security.summary.arc(SummaryARCParamsquery?, RequestOptionsoptions?): SummaryARCResponse`

**get** `/radar/email/security/summary/arc`

Retrieves the distribution of emails by ARC (Authenticated Received Chain) validation.

### Parameters

- `query: SummaryARCParams`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `tlsVersion?: Array<"TLSv1_0" | "TLSv1_1" | "TLSv1_2" | "TLSv1_3">`

    Filters results by TLS version.

    - `"TLSv1_0"`

    - `"TLSv1_1"`

    - `"TLSv1_2"`

    - `"TLSv1_3"`

### Returns

- `SummaryARCResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: RadarEmailSummary`

    - `FAIL: string`

      A numeric string.

    - `NONE: string`

      A numeric string.

    - `PASS: string`

      A numeric string.

### Example

```typescript
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.summary.arc();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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": "10",
      "NONE": "10",
      "PASS": "10"
    }
  },
  "success": true
}
```

## Get email DKIM validation summary

`client.radar.email.security.summary.dkim(SummaryDKIMParamsquery?, RequestOptionsoptions?): SummaryDKIMResponse`

**get** `/radar/email/security/summary/dkim`

Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) validation.

### Parameters

- `query: SummaryDKIMParams`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `tlsVersion?: Array<"TLSv1_0" | "TLSv1_1" | "TLSv1_2" | "TLSv1_3">`

    Filters results by TLS version.

    - `"TLSv1_0"`

    - `"TLSv1_1"`

    - `"TLSv1_2"`

    - `"TLSv1_3"`

### Returns

- `SummaryDKIMResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: RadarEmailSummary`

    - `FAIL: string`

      A numeric string.

    - `NONE: string`

      A numeric string.

    - `PASS: string`

      A numeric string.

### Example

```typescript
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.summary.dkim();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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": "10",
      "NONE": "10",
      "PASS": "10"
    }
  },
  "success": true
}
```

## Get email DMARC validation summary

`client.radar.email.security.summary.dmarc(SummaryDMARCParamsquery?, RequestOptionsoptions?): SummaryDMARCResponse`

**get** `/radar/email/security/summary/dmarc`

Retrieves the distribution of emails by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation.

### Parameters

- `query: SummaryDMARCParams`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `tlsVersion?: Array<"TLSv1_0" | "TLSv1_1" | "TLSv1_2" | "TLSv1_3">`

    Filters results by TLS version.

    - `"TLSv1_0"`

    - `"TLSv1_1"`

    - `"TLSv1_2"`

    - `"TLSv1_3"`

### Returns

- `SummaryDMARCResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: RadarEmailSummary`

    - `FAIL: string`

      A numeric string.

    - `NONE: string`

      A numeric string.

    - `PASS: string`

      A numeric string.

### Example

```typescript
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.summary.dmarc();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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": "10",
      "NONE": "10",
      "PASS": "10"
    }
  },
  "success": true
}
```

## Get email malicious classification summary

`client.radar.email.security.summary.malicious(SummaryMaliciousParamsquery?, RequestOptionsoptions?): SummaryMaliciousResponse`

**get** `/radar/email/security/summary/malicious`

Retrieves the distribution of emails by malicious classification.

### Parameters

- `query: SummaryMaliciousParams`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `tlsVersion?: Array<"TLSv1_0" | "TLSv1_1" | "TLSv1_2" | "TLSv1_3">`

    Filters results by TLS version.

    - `"TLSv1_0"`

    - `"TLSv1_1"`

    - `"TLSv1_2"`

    - `"TLSv1_3"`

### Returns

- `SummaryMaliciousResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: Summary0`

    - `MALICIOUS: string`

      A numeric string.

    - `NOT_MALICIOUS: string`

      A numeric string.

### Example

```typescript
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.summary.malicious();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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": {
      "MALICIOUS": "10",
      "NOT_MALICIOUS": "10"
    }
  },
  "success": true
}
```

## Get email spam classification summary

`client.radar.email.security.summary.spam(SummarySpamParamsquery?, RequestOptionsoptions?): SummarySpamResponse`

**get** `/radar/email/security/summary/spam`

Retrieves the proportion of emails by spam classification (spam vs. non-spam).

### Parameters

- `query: SummarySpamParams`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `tlsVersion?: Array<"TLSv1_0" | "TLSv1_1" | "TLSv1_2" | "TLSv1_3">`

    Filters results by TLS version.

    - `"TLSv1_0"`

    - `"TLSv1_1"`

    - `"TLSv1_2"`

    - `"TLSv1_3"`

### Returns

- `SummarySpamResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: Summary0`

    - `NOT_SPAM: string`

      A numeric string.

    - `SPAM: string`

      A numeric string.

### Example

```typescript
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.summary.spam();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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": {
      "NOT_SPAM": "10",
      "SPAM": "10"
    }
  },
  "success": true
}
```

## Get email SPF validation summary

`client.radar.email.security.summary.spf(SummarySPFParamsquery?, RequestOptionsoptions?): SummarySPFResponse`

**get** `/radar/email/security/summary/spf`

Retrieves the distribution of emails by SPF (Sender Policy Framework) validation.

### Parameters

- `query: SummarySPFParams`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `tlsVersion?: Array<"TLSv1_0" | "TLSv1_1" | "TLSv1_2" | "TLSv1_3">`

    Filters results by TLS version.

    - `"TLSv1_0"`

    - `"TLSv1_1"`

    - `"TLSv1_2"`

    - `"TLSv1_3"`

### Returns

- `SummarySPFResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: RadarEmailSummary`

    - `FAIL: string`

      A numeric string.

    - `NONE: string`

      A numeric string.

    - `PASS: string`

      A numeric string.

### Example

```typescript
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.summary.spf();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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": "10",
      "NONE": "10",
      "PASS": "10"
    }
  },
  "success": true
}
```

## Get email threat category summary

`client.radar.email.security.summary.threatCategory(SummaryThreatCategoryParamsquery?, RequestOptionsoptions?): SummaryThreatCategoryResponse`

**get** `/radar/email/security/summary/threat_category`

Retrieves the distribution of emails by threat categories.

### Parameters

- `query: SummaryThreatCategoryParams`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `tlsVersion?: Array<"TLSv1_0" | "TLSv1_1" | "TLSv1_2" | "TLSv1_3">`

    Filters results by TLS version.

    - `"TLSv1_0"`

    - `"TLSv1_1"`

    - `"TLSv1_2"`

    - `"TLSv1_3"`

### Returns

- `SummaryThreatCategoryResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: Summary0`

    - `BrandImpersonation: string`

      A numeric string.

    - `CredentialHarvester: string`

      A numeric string.

    - `IdentityDeception: string`

      A numeric string.

    - `Link: string`

      A numeric string.

### Example

```typescript
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.summary.threatCategory();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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": {
      "BrandImpersonation": "10",
      "CredentialHarvester": "10",
      "IdentityDeception": "10",
      "Link": "10"
    }
  },
  "success": true
}
```

## Get email spoof classification summary

`client.radar.email.security.summary.spoof(SummarySpoofParamsquery?, RequestOptionsoptions?): SummarySpoofResponse`

**get** `/radar/email/security/summary/spoof`

Retrieves the proportion of emails by spoof classification (spoof vs. non-spoof).

### Parameters

- `query: SummarySpoofParams`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `tlsVersion?: Array<"TLSv1_0" | "TLSv1_1" | "TLSv1_2" | "TLSv1_3">`

    Filters results by TLS version.

    - `"TLSv1_0"`

    - `"TLSv1_1"`

    - `"TLSv1_2"`

    - `"TLSv1_3"`

### Returns

- `SummarySpoofResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: Summary0`

    - `NOT_SPOOF: string`

      A numeric string.

    - `SPOOF: string`

      A numeric string.

### Example

```typescript
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.summary.spoof();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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": {
      "NOT_SPOOF": "10",
      "SPOOF": "10"
    }
  },
  "success": true
}
```

## Get email TLS version summary

`client.radar.email.security.summary.tlsVersion(SummaryTLSVersionParamsquery?, RequestOptionsoptions?): SummaryTLSVersionResponse`

**get** `/radar/email/security/summary/tls_version`

Retrieves the distribution of emails by TLS version.

### Parameters

- `query: SummaryTLSVersionParams`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

### Returns

- `SummaryTLSVersionResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: Summary0`

    - `"TLS 1.0": string`

      A numeric string.

    - `"TLS 1.1": string`

      A numeric string.

    - `"TLS 1.2": string`

      A numeric string.

    - `"TLS 1.3": string`

      A numeric string.

### Example

```typescript
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.summary.tlsVersion();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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": {
      "TLS 1.0": "10",
      "TLS 1.1": "10",
      "TLS 1.2": "10",
      "TLS 1.3": "10"
    }
  },
  "success": true
}
```

## Domain Types

### Summary ARC Response

- `SummaryARCResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: RadarEmailSummary`

    - `FAIL: string`

      A numeric string.

    - `NONE: string`

      A numeric string.

    - `PASS: string`

      A numeric string.

### Summary DKIM Response

- `SummaryDKIMResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: RadarEmailSummary`

    - `FAIL: string`

      A numeric string.

    - `NONE: string`

      A numeric string.

    - `PASS: string`

      A numeric string.

### Summary DMARC Response

- `SummaryDMARCResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: RadarEmailSummary`

    - `FAIL: string`

      A numeric string.

    - `NONE: string`

      A numeric string.

    - `PASS: string`

      A numeric string.

### Summary Malicious Response

- `SummaryMaliciousResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: Summary0`

    - `MALICIOUS: string`

      A numeric string.

    - `NOT_MALICIOUS: string`

      A numeric string.

### Summary Spam Response

- `SummarySpamResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: Summary0`

    - `NOT_SPAM: string`

      A numeric string.

    - `SPAM: string`

      A numeric string.

### Summary SPF Response

- `SummarySPFResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: RadarEmailSummary`

    - `FAIL: string`

      A numeric string.

    - `NONE: string`

      A numeric string.

    - `PASS: string`

      A numeric string.

### Summary Threat Category Response

- `SummaryThreatCategoryResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: Summary0`

    - `BrandImpersonation: string`

      A numeric string.

    - `CredentialHarvester: string`

      A numeric string.

    - `IdentityDeception: string`

      A numeric string.

    - `Link: string`

      A numeric string.

### Summary Spoof Response

- `SummarySpoofResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: Summary0`

    - `NOT_SPOOF: string`

      A numeric string.

    - `SPOOF: string`

      A numeric string.

### Summary TLS Version Response

- `SummaryTLSVersionResponse`

  - `meta: Meta`

    Metadata for the results.

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `summary_0: Summary0`

    - `"TLS 1.0": string`

      A numeric string.

    - `"TLS 1.1": string`

      A numeric string.

    - `"TLS 1.2": string`

      A numeric string.

    - `"TLS 1.3": string`

      A numeric string.

# Timeseries Groups

## Get email ARC validation time series

`client.radar.email.security.timeseriesGroups.arc(TimeseriesGroupARCParamsquery?, RequestOptionsoptions?): TimeseriesGroupARCResponse`

**get** `/radar/email/security/timeseries_groups/arc`

Retrieves the distribution of emails by ARC (Authenticated Received Chain) validation over time.

### Parameters

- `query: TimeseriesGroupARCParams`

  - `aggInterval?: "15m" | "1h" | "1d" | "1w"`

    Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/). When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected.

    - `"15m"`

    - `"1h"`

    - `"1d"`

    - `"1w"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `tlsVersion?: Array<"TLSv1_0" | "TLSv1_1" | "TLSv1_2" | "TLSv1_3">`

    Filters results by TLS version.

    - `"TLSv1_0"`

    - `"TLSv1_1"`

    - `"TLSv1_2"`

    - `"TLSv1_3"`

### Returns

- `TimeseriesGroupARCResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: RadarEmailSeries`

    - `FAIL: Array<string>`

    - `NONE: Array<string>`

    - `PASS: Array<string>`

### Example

```typescript
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.timeseriesGroups.arc();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "aggInterval": "FIFTEEN_MINUTES",
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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"
        }
      ]
    },
    "serie_0": {
      "FAIL": [
        "10"
      ],
      "NONE": [
        "10"
      ],
      "PASS": [
        "10"
      ]
    }
  },
  "success": true
}
```

## Get email DKIM validation time series

`client.radar.email.security.timeseriesGroups.dkim(TimeseriesGroupDKIMParamsquery?, RequestOptionsoptions?): TimeseriesGroupDKIMResponse`

**get** `/radar/email/security/timeseries_groups/dkim`

Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) validation over time.

### Parameters

- `query: TimeseriesGroupDKIMParams`

  - `aggInterval?: "15m" | "1h" | "1d" | "1w"`

    Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/). When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected.

    - `"15m"`

    - `"1h"`

    - `"1d"`

    - `"1w"`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `tlsVersion?: Array<"TLSv1_0" | "TLSv1_1" | "TLSv1_2" | "TLSv1_3">`

    Filters results by TLS version.

    - `"TLSv1_0"`

    - `"TLSv1_1"`

    - `"TLSv1_2"`

    - `"TLSv1_3"`

### Returns

- `TimeseriesGroupDKIMResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: RadarEmailSeries`

    - `FAIL: Array<string>`

    - `NONE: Array<string>`

    - `PASS: Array<string>`

### Example

```typescript
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.timeseriesGroups.dkim();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "aggInterval": "FIFTEEN_MINUTES",
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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"
        }
      ]
    },
    "serie_0": {
      "FAIL": [
        "10"
      ],
      "NONE": [
        "10"
      ],
      "PASS": [
        "10"
      ]
    }
  },
  "success": true
}
```

## Get email DMARC validation time series

`client.radar.email.security.timeseriesGroups.dmarc(TimeseriesGroupDMARCParamsquery?, RequestOptionsoptions?): TimeseriesGroupDMARCResponse`

**get** `/radar/email/security/timeseries_groups/dmarc`

Retrieves the distribution of emails by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation over time.

### Parameters

- `query: TimeseriesGroupDMARCParams`

  - `aggInterval?: "15m" | "1h" | "1d" | "1w"`

    Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/). When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected.

    - `"15m"`

    - `"1h"`

    - `"1d"`

    - `"1w"`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `tlsVersion?: Array<"TLSv1_0" | "TLSv1_1" | "TLSv1_2" | "TLSv1_3">`

    Filters results by TLS version.

    - `"TLSv1_0"`

    - `"TLSv1_1"`

    - `"TLSv1_2"`

    - `"TLSv1_3"`

### Returns

- `TimeseriesGroupDMARCResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: RadarEmailSeries`

    - `FAIL: Array<string>`

    - `NONE: Array<string>`

    - `PASS: Array<string>`

### Example

```typescript
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.timeseriesGroups.dmarc();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "aggInterval": "FIFTEEN_MINUTES",
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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"
        }
      ]
    },
    "serie_0": {
      "FAIL": [
        "10"
      ],
      "NONE": [
        "10"
      ],
      "PASS": [
        "10"
      ]
    }
  },
  "success": true
}
```

## Get email malicious classification time series

`client.radar.email.security.timeseriesGroups.malicious(TimeseriesGroupMaliciousParamsquery?, RequestOptionsoptions?): TimeseriesGroupMaliciousResponse`

**get** `/radar/email/security/timeseries_groups/malicious`

Retrieves the distribution of emails by malicious classification over time.

### Parameters

- `query: TimeseriesGroupMaliciousParams`

  - `aggInterval?: "15m" | "1h" | "1d" | "1w"`

    Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/). When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected.

    - `"15m"`

    - `"1h"`

    - `"1d"`

    - `"1w"`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `tlsVersion?: Array<"TLSv1_0" | "TLSv1_1" | "TLSv1_2" | "TLSv1_3">`

    Filters results by TLS version.

    - `"TLSv1_0"`

    - `"TLSv1_1"`

    - `"TLSv1_2"`

    - `"TLSv1_3"`

### Returns

- `TimeseriesGroupMaliciousResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: Serie0`

    - `MALICIOUS: Array<string>`

    - `NOT_MALICIOUS: Array<string>`

### Example

```typescript
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.timeseriesGroups.malicious();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "aggInterval": "FIFTEEN_MINUTES",
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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"
        }
      ]
    },
    "serie_0": {
      "MALICIOUS": [
        "10"
      ],
      "NOT_MALICIOUS": [
        "10"
      ]
    }
  },
  "success": true
}
```

## Get email spam classification time series

`client.radar.email.security.timeseriesGroups.spam(TimeseriesGroupSpamParamsquery?, RequestOptionsoptions?): TimeseriesGroupSpamResponse`

**get** `/radar/email/security/timeseries_groups/spam`

Retrieves the distribution of emails by spam classification (spam vs. non-spam) over time.

### Parameters

- `query: TimeseriesGroupSpamParams`

  - `aggInterval?: "15m" | "1h" | "1d" | "1w"`

    Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/). When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected.

    - `"15m"`

    - `"1h"`

    - `"1d"`

    - `"1w"`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `tlsVersion?: Array<"TLSv1_0" | "TLSv1_1" | "TLSv1_2" | "TLSv1_3">`

    Filters results by TLS version.

    - `"TLSv1_0"`

    - `"TLSv1_1"`

    - `"TLSv1_2"`

    - `"TLSv1_3"`

### Returns

- `TimeseriesGroupSpamResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: Serie0`

    - `NOT_SPAM: Array<string>`

    - `SPAM: Array<string>`

### Example

```typescript
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.timeseriesGroups.spam();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "aggInterval": "FIFTEEN_MINUTES",
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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"
        }
      ]
    },
    "serie_0": {
      "NOT_SPAM": [
        "10"
      ],
      "SPAM": [
        "10"
      ]
    }
  },
  "success": true
}
```

## Get email SPF validation time series

`client.radar.email.security.timeseriesGroups.spf(TimeseriesGroupSPFParamsquery?, RequestOptionsoptions?): TimeseriesGroupSPFResponse`

**get** `/radar/email/security/timeseries_groups/spf`

Retrieves the distribution of emails by SPF (Sender Policy Framework) validation over time.

### Parameters

- `query: TimeseriesGroupSPFParams`

  - `aggInterval?: "15m" | "1h" | "1d" | "1w"`

    Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/). When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected.

    - `"15m"`

    - `"1h"`

    - `"1d"`

    - `"1w"`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `tlsVersion?: Array<"TLSv1_0" | "TLSv1_1" | "TLSv1_2" | "TLSv1_3">`

    Filters results by TLS version.

    - `"TLSv1_0"`

    - `"TLSv1_1"`

    - `"TLSv1_2"`

    - `"TLSv1_3"`

### Returns

- `TimeseriesGroupSPFResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: RadarEmailSeries`

    - `FAIL: Array<string>`

    - `NONE: Array<string>`

    - `PASS: Array<string>`

### Example

```typescript
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.timeseriesGroups.spf();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "aggInterval": "FIFTEEN_MINUTES",
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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"
        }
      ]
    },
    "serie_0": {
      "FAIL": [
        "10"
      ],
      "NONE": [
        "10"
      ],
      "PASS": [
        "10"
      ]
    }
  },
  "success": true
}
```

## Get email threat category time series

`client.radar.email.security.timeseriesGroups.threatCategory(TimeseriesGroupThreatCategoryParamsquery?, RequestOptionsoptions?): TimeseriesGroupThreatCategoryResponse`

**get** `/radar/email/security/timeseries_groups/threat_category`

Retrieves the distribution of emails by threat category over time.

### Parameters

- `query: TimeseriesGroupThreatCategoryParams`

  - `aggInterval?: "15m" | "1h" | "1d" | "1w"`

    Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/). When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected.

    - `"15m"`

    - `"1h"`

    - `"1d"`

    - `"1w"`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `tlsVersion?: Array<"TLSv1_0" | "TLSv1_1" | "TLSv1_2" | "TLSv1_3">`

    Filters results by TLS version.

    - `"TLSv1_0"`

    - `"TLSv1_1"`

    - `"TLSv1_2"`

    - `"TLSv1_3"`

### Returns

- `TimeseriesGroupThreatCategoryResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: Serie0`

    - `BrandImpersonation: Array<string>`

    - `CredentialHarvester: Array<string>`

    - `IdentityDeception: Array<string>`

    - `Link: Array<string>`

### Example

```typescript
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.timeseriesGroups.threatCategory();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "aggInterval": "FIFTEEN_MINUTES",
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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"
        }
      ]
    },
    "serie_0": {
      "BrandImpersonation": [
        "10"
      ],
      "CredentialHarvester": [
        "10"
      ],
      "IdentityDeception": [
        "10"
      ],
      "Link": [
        "10"
      ]
    }
  },
  "success": true
}
```

## Get email spoof classification time series

`client.radar.email.security.timeseriesGroups.spoof(TimeseriesGroupSpoofParamsquery?, RequestOptionsoptions?): TimeseriesGroupSpoofResponse`

**get** `/radar/email/security/timeseries_groups/spoof`

Retrieves the distribution of emails by spoof classification (spoof vs. non-spoof) over time.

### Parameters

- `query: TimeseriesGroupSpoofParams`

  - `aggInterval?: "15m" | "1h" | "1d" | "1w"`

    Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/). When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected.

    - `"15m"`

    - `"1h"`

    - `"1d"`

    - `"1w"`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `tlsVersion?: Array<"TLSv1_0" | "TLSv1_1" | "TLSv1_2" | "TLSv1_3">`

    Filters results by TLS version.

    - `"TLSv1_0"`

    - `"TLSv1_1"`

    - `"TLSv1_2"`

    - `"TLSv1_3"`

### Returns

- `TimeseriesGroupSpoofResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: Serie0`

    - `NOT_SPOOF: Array<string>`

    - `SPOOF: Array<string>`

### Example

```typescript
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.timeseriesGroups.spoof();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "aggInterval": "FIFTEEN_MINUTES",
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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"
        }
      ]
    },
    "serie_0": {
      "NOT_SPOOF": [
        "10"
      ],
      "SPOOF": [
        "10"
      ]
    }
  },
  "success": true
}
```

## Get email TLS version time series

`client.radar.email.security.timeseriesGroups.tlsVersion(TimeseriesGroupTLSVersionParamsquery?, RequestOptionsoptions?): TimeseriesGroupTLSVersionResponse`

**get** `/radar/email/security/timeseries_groups/tls_version`

Retrieves the distribution of emails by TLS version over time.

### Parameters

- `query: TimeseriesGroupTLSVersionParams`

  - `aggInterval?: "15m" | "1h" | "1d" | "1w"`

    Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/). When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected.

    - `"15m"`

    - `"1h"`

    - `"1d"`

    - `"1w"`

  - `arc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by ARC (Authenticated Received Chain) validation.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `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.

  - `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).

  - `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.

  - `dkim?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DKIM (DomainKeys Identified Mail) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `dmarc?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `name?: Array<string>`

    Array of names used to label the series in the response.

  - `spf?: Array<"PASS" | "NONE" | "FAIL">`

    Filters results by SPF (Sender Policy Framework) validation status.

    - `"PASS"`

    - `"NONE"`

    - `"FAIL"`

### Returns

- `TimeseriesGroupTLSVersionResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: Serie0`

    - `"TLS 1.0": Array<string>`

    - `"TLS 1.1": Array<string>`

    - `"TLS 1.2": Array<string>`

    - `"TLS 1.3": Array<string>`

### Example

```typescript
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.timeseriesGroups.tlsVersion();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "aggInterval": "FIFTEEN_MINUTES",
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "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"
        }
      ]
    },
    "serie_0": {
      "TLS 1.0": [
        "10"
      ],
      "TLS 1.1": [
        "10"
      ],
      "TLS 1.2": [
        "10"
      ],
      "TLS 1.3": [
        "10"
      ]
    }
  },
  "success": true
}
```

## Domain Types

### Timeseries Group ARC Response

- `TimeseriesGroupARCResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: RadarEmailSeries`

    - `FAIL: Array<string>`

    - `NONE: Array<string>`

    - `PASS: Array<string>`

### Timeseries Group DKIM Response

- `TimeseriesGroupDKIMResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: RadarEmailSeries`

    - `FAIL: Array<string>`

    - `NONE: Array<string>`

    - `PASS: Array<string>`

### Timeseries Group DMARC Response

- `TimeseriesGroupDMARCResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: RadarEmailSeries`

    - `FAIL: Array<string>`

    - `NONE: Array<string>`

    - `PASS: Array<string>`

### Timeseries Group Malicious Response

- `TimeseriesGroupMaliciousResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: Serie0`

    - `MALICIOUS: Array<string>`

    - `NOT_MALICIOUS: Array<string>`

### Timeseries Group Spam Response

- `TimeseriesGroupSpamResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: Serie0`

    - `NOT_SPAM: Array<string>`

    - `SPAM: Array<string>`

### Timeseries Group SPF Response

- `TimeseriesGroupSPFResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: RadarEmailSeries`

    - `FAIL: Array<string>`

    - `NONE: Array<string>`

    - `PASS: Array<string>`

### Timeseries Group Threat Category Response

- `TimeseriesGroupThreatCategoryResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: Serie0`

    - `BrandImpersonation: Array<string>`

    - `CredentialHarvester: Array<string>`

    - `IdentityDeception: Array<string>`

    - `Link: Array<string>`

### Timeseries Group Spoof Response

- `TimeseriesGroupSpoofResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: Serie0`

    - `NOT_SPOOF: Array<string>`

    - `SPOOF: Array<string>`

### Timeseries Group TLS Version Response

- `TimeseriesGroupTLSVersionResponse`

  - `meta: Meta`

    Metadata for the results.

    - `aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

          Whether event is a single point in time or a time range.

        - `linkedUrl: string`

        - `startDate: string`

        - `tags?: Array<string>`

      - `level: number`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

      Timestamp of the last dataset update.

    - `normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: Array<Unit>`

      Measurement units for the results.

      - `name: string`

      - `value: string`

  - `serie_0: Serie0`

    - `"TLS 1.0": Array<string>`

    - `"TLS 1.1": Array<string>`

    - `"TLS 1.2": Array<string>`

    - `"TLS 1.3": Array<string>`