API Reference

Radar

Email

Security

Summary

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get email ARC validation summary

Deprecated: Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead.

client.Radar.Email.Security.Summary.ARC(ctx, query) (*EmailSecuritySummaryARCResponse, error)

GET/radar/email/security/summary/arc

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

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

User Details WriteUser Details Read

ParametersExpand Collapse

query EmailSecuritySummaryARCParams

DateEnd param.Field[[]Time]Optional

End of the date range (inclusive).

DateRange param.Field[[]string]Optional

Filters results by date range. For example, use 7d and 7dcontrol to compare this week with the previous week. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).

DateStart param.Field[[]Time]Optional

Start of the date range.

DKIM param.Field[[]EmailSecuritySummaryARCParamsDKIM]Optional

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

const EmailSecuritySummaryARCParamsDKIMPass EmailSecuritySummaryARCParamsDKIM = "PASS"

const EmailSecuritySummaryARCParamsDKIMNone EmailSecuritySummaryARCParamsDKIM = "NONE"

const EmailSecuritySummaryARCParamsDKIMFail EmailSecuritySummaryARCParamsDKIM = "FAIL"

DMARC param.Field[[]EmailSecuritySummaryARCParamsDMARC]Optional

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

const EmailSecuritySummaryARCParamsDMARCPass EmailSecuritySummaryARCParamsDMARC = "PASS"

const EmailSecuritySummaryARCParamsDMARCNone EmailSecuritySummaryARCParamsDMARC = "NONE"

const EmailSecuritySummaryARCParamsDMARCFail EmailSecuritySummaryARCParamsDMARC = "FAIL"

Format param.Field[EmailSecuritySummaryARCParamsFormat]Optional

Format in which results will be returned.

const EmailSecuritySummaryARCParamsFormatJson EmailSecuritySummaryARCParamsFormat = "JSON"

const EmailSecuritySummaryARCParamsFormatCsv EmailSecuritySummaryARCParamsFormat = "CSV"

Name param.Field[[]string]Optional

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

SPF param.Field[[]EmailSecuritySummaryARCParamsSPF]Optional

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

const EmailSecuritySummaryARCParamsSPFPass EmailSecuritySummaryARCParamsSPF = "PASS"

const EmailSecuritySummaryARCParamsSPFNone EmailSecuritySummaryARCParamsSPF = "NONE"

const EmailSecuritySummaryARCParamsSPFFail EmailSecuritySummaryARCParamsSPF = "FAIL"

TLSVersion param.Field[[]EmailSecuritySummaryARCParamsTLSVersion]Optional

Filters results by TLS version.

const EmailSecuritySummaryARCParamsTLSVersionTlSv1_0 EmailSecuritySummaryARCParamsTLSVersion = "TLSv1_0"

const EmailSecuritySummaryARCParamsTLSVersionTlSv1_1 EmailSecuritySummaryARCParamsTLSVersion = "TLSv1_1"

const EmailSecuritySummaryARCParamsTLSVersionTlSv1_2 EmailSecuritySummaryARCParamsTLSVersion = "TLSv1_2"

const EmailSecuritySummaryARCParamsTLSVersionTlSv1_3 EmailSecuritySummaryARCParamsTLSVersion = "TLSv1_3"

ReturnsExpand Collapse

type EmailSecuritySummaryARCResponse struct{…}

Meta EmailSecuritySummaryARCResponseMeta

Metadata for the results.

ConfidenceInfo EmailSecuritySummaryARCResponseMetaConfidenceInfo

Annotations []EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotation

DataSource EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource

Data source for annotations.

One of the following:

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceAll EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "ALL"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceAIBots EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "AI_BOTS"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceAIGateway EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "AI_GATEWAY"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceBGP EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "BGP"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceBots EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "BOTS"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceConnectionAnomaly EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "CONNECTION_ANOMALY"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceCT EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "CT"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceDNS EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "DNS"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceDNSMagnitude EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_MAGNITUDE"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceDNSAS112 EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_AS112"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceDos EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "DOS"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceEmailRouting EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_ROUTING"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceEmailSecurity EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_SECURITY"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceFw EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "FW"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceFwPg EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "FW_PG"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceHTTP EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceHTTPControl EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CONTROL"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceHTTPCrawlerReferer EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CRAWLER_REFERER"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceHTTPOrigins EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_ORIGINS"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceIQI EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "IQI"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceLeakedCredentials EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "LEAKED_CREDENTIALS"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceNet EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "NET"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceRobotsTXT EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "ROBOTS_TXT"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceSpeed EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "SPEED"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceWorkersAI EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "WORKERS_AI"

Description string

EndDate Time

formatdate-time

EventType EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsEventType

Event type for annotations.

One of the following:

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsEventTypeEvent EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsEventType = "EVENT"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsEventTypeGeneral EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsEventType = "GENERAL"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsEventTypeOutage EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsEventType = "OUTAGE"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsEventTypePartialProjection EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsEventType = "PARTIAL_PROJECTION"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsEventTypePipeline EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsEventType = "PIPELINE"

const EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsEventTypeTrafficAnomaly EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationsEventType = "TRAFFIC_ANOMALY"

IsInstantaneous bool

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

LinkedURL string

formaturi

StartDate Time

formatdate-time

Tags []stringOptional

Level int64

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

DateRange []EmailSecuritySummaryARCResponseMetaDateRange

EndTime Time

Adjusted end of date range.

formatdate-time

StartTime Time

Adjusted start of date range.

formatdate-time

LastUpdated Time

Timestamp of the last dataset update.

formatdate-time

Normalization EmailSecuritySummaryARCResponseMetaNormalization

Normalization method applied to the results. Refer to Normalization methods.

One of the following:

const EmailSecuritySummaryARCResponseMetaNormalizationPercentage EmailSecuritySummaryARCResponseMetaNormalization = "PERCENTAGE"

const EmailSecuritySummaryARCResponseMetaNormalizationMin0Max EmailSecuritySummaryARCResponseMetaNormalization = "MIN0_MAX"

const EmailSecuritySummaryARCResponseMetaNormalizationMinMax EmailSecuritySummaryARCResponseMetaNormalization = "MIN_MAX"

const EmailSecuritySummaryARCResponseMetaNormalizationRawValues EmailSecuritySummaryARCResponseMetaNormalization = "RAW_VALUES"

const EmailSecuritySummaryARCResponseMetaNormalizationPercentageChange EmailSecuritySummaryARCResponseMetaNormalization = "PERCENTAGE_CHANGE"

const EmailSecuritySummaryARCResponseMetaNormalizationRollingAverage EmailSecuritySummaryARCResponseMetaNormalization = "ROLLING_AVERAGE"

const EmailSecuritySummaryARCResponseMetaNormalizationOverlappedPercentage EmailSecuritySummaryARCResponseMetaNormalization = "OVERLAPPED_PERCENTAGE"

const EmailSecuritySummaryARCResponseMetaNormalizationRatio EmailSecuritySummaryARCResponseMetaNormalization = "RATIO"

Units []EmailSecuritySummaryARCResponseMetaUnit

Measurement units for the results.

Name string

Value string

Summary0 RadarEmailSummary

Fail string

A numeric string.

None string

A numeric string.

Pass string

A numeric string.

Get email ARC validation summary

Go

HTTP

TypeScript

Python

Go

Terraform

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/option"
  "github.com/stainless-sdks/cloudflare-go/radar"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.Radar.Email.Security.Summary.ARC(context.TODO(), radar.EmailSecuritySummaryARCParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Meta)
}

200 example

{
  "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
}

Returns Examples

200 example

{
  "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
}