API Reference

Radar

Email

Routing

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 Routing Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/summary_v2/) instead.

client.Radar.Email.Routing.Summary.ARC(ctx, query) (*EmailRoutingSummaryARCResponse, error)

GET/radar/email/routing/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 EmailRoutingSummaryARCParams

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[[]EmailRoutingSummaryARCParamsDKIM]Optional

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

const EmailRoutingSummaryARCParamsDKIMPass EmailRoutingSummaryARCParamsDKIM = "PASS"

const EmailRoutingSummaryARCParamsDKIMNone EmailRoutingSummaryARCParamsDKIM = "NONE"

const EmailRoutingSummaryARCParamsDKIMFail EmailRoutingSummaryARCParamsDKIM = "FAIL"

DMARC param.Field[[]EmailRoutingSummaryARCParamsDMARC]Optional

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

const EmailRoutingSummaryARCParamsDMARCPass EmailRoutingSummaryARCParamsDMARC = "PASS"

const EmailRoutingSummaryARCParamsDMARCNone EmailRoutingSummaryARCParamsDMARC = "NONE"

const EmailRoutingSummaryARCParamsDMARCFail EmailRoutingSummaryARCParamsDMARC = "FAIL"

Encrypted param.Field[[]EmailRoutingSummaryARCParamsEncrypted]Optional

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

const EmailRoutingSummaryARCParamsEncryptedEncrypted EmailRoutingSummaryARCParamsEncrypted = "ENCRYPTED"

const EmailRoutingSummaryARCParamsEncryptedNotEncrypted EmailRoutingSummaryARCParamsEncrypted = "NOT_ENCRYPTED"

Format param.Field[EmailRoutingSummaryARCParamsFormat]Optional

Format in which results will be returned.

const EmailRoutingSummaryARCParamsFormatJson EmailRoutingSummaryARCParamsFormat = "JSON"

const EmailRoutingSummaryARCParamsFormatCsv EmailRoutingSummaryARCParamsFormat = "CSV"

IPVersion param.Field[[]EmailRoutingSummaryARCParamsIPVersion]Optional

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

const EmailRoutingSummaryARCParamsIPVersionIPv4 EmailRoutingSummaryARCParamsIPVersion = "IPv4"

const EmailRoutingSummaryARCParamsIPVersionIPv6 EmailRoutingSummaryARCParamsIPVersion = "IPv6"

Name param.Field[[]string]Optional

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

SPF param.Field[[]EmailRoutingSummaryARCParamsSPF]Optional

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

const EmailRoutingSummaryARCParamsSPFPass EmailRoutingSummaryARCParamsSPF = "PASS"

const EmailRoutingSummaryARCParamsSPFNone EmailRoutingSummaryARCParamsSPF = "NONE"

const EmailRoutingSummaryARCParamsSPFFail EmailRoutingSummaryARCParamsSPF = "FAIL"

ReturnsExpand Collapse

type EmailRoutingSummaryARCResponse struct{…}

Meta EmailRoutingSummaryARCResponseMeta

Metadata for the results.

ConfidenceInfo EmailRoutingSummaryARCResponseMetaConfidenceInfo

Annotations []EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotation

DataSource EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource

Data source for annotations.

One of the following:

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceAll EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "ALL"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceAIBots EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "AI_BOTS"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceAIGateway EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "AI_GATEWAY"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceBGP EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "BGP"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceBots EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "BOTS"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceConnectionAnomaly EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "CONNECTION_ANOMALY"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceCT EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "CT"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceDNS EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "DNS"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceDNSMagnitude EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_MAGNITUDE"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceDNSAS112 EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_AS112"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceDos EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "DOS"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceEmailRouting EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_ROUTING"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceEmailSecurity EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_SECURITY"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceFw EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "FW"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceFwPg EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "FW_PG"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceHTTP EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceHTTPControl EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CONTROL"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceHTTPCrawlerReferer EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CRAWLER_REFERER"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceHTTPOrigins EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_ORIGINS"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceIQI EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "IQI"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceLeakedCredentials EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "LEAKED_CREDENTIALS"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceNet EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "NET"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceRobotsTXT EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "ROBOTS_TXT"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceSpeed EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "SPEED"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSourceWorkersAI EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsDataSource = "WORKERS_AI"

Description string

EndDate Time

formatdate-time

EventType EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsEventType

Event type for annotations.

One of the following:

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsEventTypeEvent EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsEventType = "EVENT"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsEventTypeGeneral EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsEventType = "GENERAL"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsEventTypeOutage EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsEventType = "OUTAGE"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsEventTypePartialProjection EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsEventType = "PARTIAL_PROJECTION"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsEventTypePipeline EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsEventType = "PIPELINE"

const EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsEventTypeTrafficAnomaly EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationsEventType = "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 []EmailRoutingSummaryARCResponseMetaDateRange

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 EmailRoutingSummaryARCResponseMetaNormalization

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

One of the following:

const EmailRoutingSummaryARCResponseMetaNormalizationPercentage EmailRoutingSummaryARCResponseMetaNormalization = "PERCENTAGE"

const EmailRoutingSummaryARCResponseMetaNormalizationMin0Max EmailRoutingSummaryARCResponseMetaNormalization = "MIN0_MAX"

const EmailRoutingSummaryARCResponseMetaNormalizationMinMax EmailRoutingSummaryARCResponseMetaNormalization = "MIN_MAX"

const EmailRoutingSummaryARCResponseMetaNormalizationRawValues EmailRoutingSummaryARCResponseMetaNormalization = "RAW_VALUES"

const EmailRoutingSummaryARCResponseMetaNormalizationPercentageChange EmailRoutingSummaryARCResponseMetaNormalization = "PERCENTAGE_CHANGE"

const EmailRoutingSummaryARCResponseMetaNormalizationRollingAverage EmailRoutingSummaryARCResponseMetaNormalization = "ROLLING_AVERAGE"

const EmailRoutingSummaryARCResponseMetaNormalizationOverlappedPercentage EmailRoutingSummaryARCResponseMetaNormalization = "OVERLAPPED_PERCENTAGE"

const EmailRoutingSummaryARCResponseMetaNormalizationRatio EmailRoutingSummaryARCResponseMetaNormalization = "RATIO"

Units []EmailRoutingSummaryARCResponseMetaUnit

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.Routing.Summary.ARC(context.TODO(), radar.EmailRoutingSummaryARCParams{

  })
  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
}