Get email spoof classification summary

client.Radar.Email.Security.Summary.Spoof(ctx, query) (*EmailSecuritySummarySpoofResponse, error)

GET/radar/email/security/summary/spoof

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

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 EmailSecuritySummarySpoofParams

ARC param.Field[[]EmailSecuritySummarySpoofParamsARC]Optional

Filters results by ARC (Authenticated Received Chain) validation.

const EmailSecuritySummarySpoofParamsARCPass EmailSecuritySummarySpoofParamsARC = "PASS"

const EmailSecuritySummarySpoofParamsARCNone EmailSecuritySummarySpoofParamsARC = "NONE"

const EmailSecuritySummarySpoofParamsARCFail EmailSecuritySummarySpoofParamsARC = "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[[]EmailSecuritySummarySpoofParamsDKIM]Optional

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

const EmailSecuritySummarySpoofParamsDKIMPass EmailSecuritySummarySpoofParamsDKIM = "PASS"

const EmailSecuritySummarySpoofParamsDKIMNone EmailSecuritySummarySpoofParamsDKIM = "NONE"

const EmailSecuritySummarySpoofParamsDKIMFail EmailSecuritySummarySpoofParamsDKIM = "FAIL"

DMARC param.Field[[]EmailSecuritySummarySpoofParamsDMARC]Optional

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

const EmailSecuritySummarySpoofParamsDMARCPass EmailSecuritySummarySpoofParamsDMARC = "PASS"

const EmailSecuritySummarySpoofParamsDMARCNone EmailSecuritySummarySpoofParamsDMARC = "NONE"

const EmailSecuritySummarySpoofParamsDMARCFail EmailSecuritySummarySpoofParamsDMARC = "FAIL"

Format param.Field[EmailSecuritySummarySpoofParamsFormat]Optional

Format in which results will be returned.

const EmailSecuritySummarySpoofParamsFormatJson EmailSecuritySummarySpoofParamsFormat = "JSON"

const EmailSecuritySummarySpoofParamsFormatCsv EmailSecuritySummarySpoofParamsFormat = "CSV"

Name param.Field[[]string]Optional

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

SPF param.Field[[]EmailSecuritySummarySpoofParamsSPF]Optional

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

const EmailSecuritySummarySpoofParamsSPFPass EmailSecuritySummarySpoofParamsSPF = "PASS"

const EmailSecuritySummarySpoofParamsSPFNone EmailSecuritySummarySpoofParamsSPF = "NONE"

const EmailSecuritySummarySpoofParamsSPFFail EmailSecuritySummarySpoofParamsSPF = "FAIL"

TLSVersion param.Field[[]EmailSecuritySummarySpoofParamsTLSVersion]Optional

Filters results by TLS version.

const EmailSecuritySummarySpoofParamsTLSVersionTlSv1_0 EmailSecuritySummarySpoofParamsTLSVersion = "TLSv1_0"

const EmailSecuritySummarySpoofParamsTLSVersionTlSv1_1 EmailSecuritySummarySpoofParamsTLSVersion = "TLSv1_1"

const EmailSecuritySummarySpoofParamsTLSVersionTlSv1_2 EmailSecuritySummarySpoofParamsTLSVersion = "TLSv1_2"

const EmailSecuritySummarySpoofParamsTLSVersionTlSv1_3 EmailSecuritySummarySpoofParamsTLSVersion = "TLSv1_3"

ReturnsExpand Collapse

type EmailSecuritySummarySpoofResponse struct{…}

Meta EmailSecuritySummarySpoofResponseMeta

Metadata for the results.

ConfidenceInfo EmailSecuritySummarySpoofResponseMetaConfidenceInfo

Annotations []EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotation

DataSource EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource

Data source for annotations.

One of the following:

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceAll EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "ALL"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceAIBots EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "AI_BOTS"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceAIGateway EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "AI_GATEWAY"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceBGP EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "BGP"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceBots EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "BOTS"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceConnectionAnomaly EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "CONNECTION_ANOMALY"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceCT EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "CT"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceDNS EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "DNS"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceDNSMagnitude EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_MAGNITUDE"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceDNSAS112 EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_AS112"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceDos EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "DOS"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceEmailRouting EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_ROUTING"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceEmailSecurity EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_SECURITY"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceFw EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "FW"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceFwPg EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "FW_PG"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceHTTP EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceHTTPControl EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CONTROL"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceHTTPCrawlerReferer EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CRAWLER_REFERER"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceHTTPOrigins EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_ORIGINS"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceIQI EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "IQI"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceLeakedCredentials EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "LEAKED_CREDENTIALS"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceNet EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "NET"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceRobotsTXT EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "ROBOTS_TXT"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceSpeed EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "SPEED"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSourceWorkersAI EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsDataSource = "WORKERS_AI"

Description string

EndDate Time

formatdate-time

EventType EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsEventType

Event type for annotations.

One of the following:

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsEventTypeEvent EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsEventType = "EVENT"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsEventTypeGeneral EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsEventType = "GENERAL"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsEventTypeOutage EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsEventType = "OUTAGE"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsEventTypePartialProjection EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsEventType = "PARTIAL_PROJECTION"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsEventTypePipeline EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsEventType = "PIPELINE"

const EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsEventTypeTrafficAnomaly EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationsEventType = "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 []EmailSecuritySummarySpoofResponseMetaDateRange

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 EmailSecuritySummarySpoofResponseMetaNormalization

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

One of the following:

const EmailSecuritySummarySpoofResponseMetaNormalizationPercentage EmailSecuritySummarySpoofResponseMetaNormalization = "PERCENTAGE"

const EmailSecuritySummarySpoofResponseMetaNormalizationMin0Max EmailSecuritySummarySpoofResponseMetaNormalization = "MIN0_MAX"

const EmailSecuritySummarySpoofResponseMetaNormalizationMinMax EmailSecuritySummarySpoofResponseMetaNormalization = "MIN_MAX"

const EmailSecuritySummarySpoofResponseMetaNormalizationRawValues EmailSecuritySummarySpoofResponseMetaNormalization = "RAW_VALUES"

const EmailSecuritySummarySpoofResponseMetaNormalizationPercentageChange EmailSecuritySummarySpoofResponseMetaNormalization = "PERCENTAGE_CHANGE"

const EmailSecuritySummarySpoofResponseMetaNormalizationRollingAverage EmailSecuritySummarySpoofResponseMetaNormalization = "ROLLING_AVERAGE"

const EmailSecuritySummarySpoofResponseMetaNormalizationOverlappedPercentage EmailSecuritySummarySpoofResponseMetaNormalization = "OVERLAPPED_PERCENTAGE"

const EmailSecuritySummarySpoofResponseMetaNormalizationRatio EmailSecuritySummarySpoofResponseMetaNormalization = "RATIO"

Units []EmailSecuritySummarySpoofResponseMetaUnit

Measurement units for the results.

Name string

Value string

Summary0 EmailSecuritySummarySpoofResponseSummary0

NotSpoof string

A numeric string.

Spoof string

A numeric string.

Get email spoof classification summary

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.Spoof(context.TODO(), radar.EmailSecuritySummarySpoofParams{

  })
  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": {
      "NOT_SPOOF": "10",
      "SPOOF": "10"
    }
  },
  "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": {
      "NOT_SPOOF": "10",
      "SPOOF": "10"
    }
  },
  "success": true
}