Get email routing summary by dimension

client.Radar.Email.Routing.SummaryV2(ctx, dimension, query) (*EmailRoutingSummaryV2Response, error)

GET/radar/email/routing/summary/{dimension}

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

Security

API Token

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

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

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

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

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

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

User Details WriteUser Details Read

ParametersExpand Collapse

dimension EmailRoutingSummaryV2ParamsDimension

Specifies the attribute by which to group the results.

One of the following:

const EmailRoutingSummaryV2ParamsDimensionIPVersion EmailRoutingSummaryV2ParamsDimension = "IP_VERSION"

const EmailRoutingSummaryV2ParamsDimensionEncrypted EmailRoutingSummaryV2ParamsDimension = "ENCRYPTED"

const EmailRoutingSummaryV2ParamsDimensionARC EmailRoutingSummaryV2ParamsDimension = "ARC"

const EmailRoutingSummaryV2ParamsDimensionDKIM EmailRoutingSummaryV2ParamsDimension = "DKIM"

const EmailRoutingSummaryV2ParamsDimensionDMARC EmailRoutingSummaryV2ParamsDimension = "DMARC"

const EmailRoutingSummaryV2ParamsDimensionSPF EmailRoutingSummaryV2ParamsDimension = "SPF"

query EmailRoutingSummaryV2Params

ARC param.Field[[]EmailRoutingSummaryV2ParamsARC]Optional

Filters results by ARC (Authenticated Received Chain) validation.

const EmailRoutingSummaryV2ParamsARCPass EmailRoutingSummaryV2ParamsARC = "PASS"

const EmailRoutingSummaryV2ParamsARCNone EmailRoutingSummaryV2ParamsARC = "NONE"

const EmailRoutingSummaryV2ParamsARCFail EmailRoutingSummaryV2ParamsARC = "FAIL"

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

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

const EmailRoutingSummaryV2ParamsDKIMPass EmailRoutingSummaryV2ParamsDKIM = "PASS"

const EmailRoutingSummaryV2ParamsDKIMNone EmailRoutingSummaryV2ParamsDKIM = "NONE"

const EmailRoutingSummaryV2ParamsDKIMFail EmailRoutingSummaryV2ParamsDKIM = "FAIL"

DMARC param.Field[[]EmailRoutingSummaryV2ParamsDMARC]Optional

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

const EmailRoutingSummaryV2ParamsDMARCPass EmailRoutingSummaryV2ParamsDMARC = "PASS"

const EmailRoutingSummaryV2ParamsDMARCNone EmailRoutingSummaryV2ParamsDMARC = "NONE"

const EmailRoutingSummaryV2ParamsDMARCFail EmailRoutingSummaryV2ParamsDMARC = "FAIL"

Encrypted param.Field[[]EmailRoutingSummaryV2ParamsEncrypted]Optional

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

const EmailRoutingSummaryV2ParamsEncryptedEncrypted EmailRoutingSummaryV2ParamsEncrypted = "ENCRYPTED"

const EmailRoutingSummaryV2ParamsEncryptedNotEncrypted EmailRoutingSummaryV2ParamsEncrypted = "NOT_ENCRYPTED"

Format param.Field[EmailRoutingSummaryV2ParamsFormat]Optional

Format in which results will be returned.

const EmailRoutingSummaryV2ParamsFormatJson EmailRoutingSummaryV2ParamsFormat = "JSON"

const EmailRoutingSummaryV2ParamsFormatCsv EmailRoutingSummaryV2ParamsFormat = "CSV"

IPVersion param.Field[[]EmailRoutingSummaryV2ParamsIPVersion]Optional

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

const EmailRoutingSummaryV2ParamsIPVersionIPv4 EmailRoutingSummaryV2ParamsIPVersion = "IPv4"

const EmailRoutingSummaryV2ParamsIPVersionIPv6 EmailRoutingSummaryV2ParamsIPVersion = "IPv6"

LimitPerGroup param.Field[int64]Optional

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.

Name param.Field[[]string]Optional

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

SPF param.Field[[]EmailRoutingSummaryV2ParamsSPF]Optional

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

const EmailRoutingSummaryV2ParamsSPFPass EmailRoutingSummaryV2ParamsSPF = "PASS"

const EmailRoutingSummaryV2ParamsSPFNone EmailRoutingSummaryV2ParamsSPF = "NONE"

const EmailRoutingSummaryV2ParamsSPFFail EmailRoutingSummaryV2ParamsSPF = "FAIL"

ReturnsExpand Collapse

type EmailRoutingSummaryV2Response struct{…}

Meta EmailRoutingSummaryV2ResponseMeta

Metadata for the results.

ConfidenceInfo EmailRoutingSummaryV2ResponseMetaConfidenceInfo

Annotations []EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotation

DataSource EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource

Data source for annotations.

One of the following:

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceAll EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "ALL"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceAIBots EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "AI_BOTS"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceAIGateway EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "AI_GATEWAY"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceBGP EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "BGP"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceBots EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "BOTS"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceConnectionAnomaly EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "CONNECTION_ANOMALY"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceCT EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "CT"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceDNS EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "DNS"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceDNSMagnitude EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_MAGNITUDE"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceDNSAS112 EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_AS112"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceDos EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "DOS"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceEmailRouting EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_ROUTING"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceEmailSecurity EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_SECURITY"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceFw EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "FW"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceFwPg EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "FW_PG"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceHTTP EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceHTTPControl EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CONTROL"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceHTTPCrawlerReferer EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CRAWLER_REFERER"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceHTTPOrigins EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_ORIGINS"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceIQI EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "IQI"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceLeakedCredentials EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "LEAKED_CREDENTIALS"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceNet EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "NET"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceRobotsTXT EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "ROBOTS_TXT"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceSpeed EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "SPEED"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceWorkersAI EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "WORKERS_AI"

Description string

EndDate Time

formatdate-time

EventType EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsEventType

Event type for annotations.

One of the following:

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsEventTypeEvent EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsEventType = "EVENT"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsEventTypeGeneral EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsEventType = "GENERAL"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsEventTypeOutage EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsEventType = "OUTAGE"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsEventTypePartialProjection EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsEventType = "PARTIAL_PROJECTION"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsEventTypePipeline EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsEventType = "PIPELINE"

const EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsEventTypeTrafficAnomaly EmailRoutingSummaryV2ResponseMetaConfidenceInfoAnnotationsEventType = "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 []EmailRoutingSummaryV2ResponseMetaDateRange

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 EmailRoutingSummaryV2ResponseMetaNormalization

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

One of the following:

const EmailRoutingSummaryV2ResponseMetaNormalizationPercentage EmailRoutingSummaryV2ResponseMetaNormalization = "PERCENTAGE"

const EmailRoutingSummaryV2ResponseMetaNormalizationMin0Max EmailRoutingSummaryV2ResponseMetaNormalization = "MIN0_MAX"

const EmailRoutingSummaryV2ResponseMetaNormalizationMinMax EmailRoutingSummaryV2ResponseMetaNormalization = "MIN_MAX"

const EmailRoutingSummaryV2ResponseMetaNormalizationRawValues EmailRoutingSummaryV2ResponseMetaNormalization = "RAW_VALUES"

const EmailRoutingSummaryV2ResponseMetaNormalizationPercentageChange EmailRoutingSummaryV2ResponseMetaNormalization = "PERCENTAGE_CHANGE"

const EmailRoutingSummaryV2ResponseMetaNormalizationRollingAverage EmailRoutingSummaryV2ResponseMetaNormalization = "ROLLING_AVERAGE"

const EmailRoutingSummaryV2ResponseMetaNormalizationOverlappedPercentage EmailRoutingSummaryV2ResponseMetaNormalization = "OVERLAPPED_PERCENTAGE"

const EmailRoutingSummaryV2ResponseMetaNormalizationRatio EmailRoutingSummaryV2ResponseMetaNormalization = "RATIO"

Units []EmailRoutingSummaryV2ResponseMetaUnit

Measurement units for the results.

Name string

Value string

Summary0 map[string, string]

Get email routing summary by dimension

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.SummaryV2(
    context.TODO(),
    radar.EmailRoutingSummaryV2ParamsDimensionIPVersion,
    radar.EmailRoutingSummaryV2Params{

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

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

Returns Examples

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