Get email security summary by dimension

client.Radar.Email.Security.SummaryV2(ctx, dimension, query) (*EmailSecuritySummaryV2Response, error)

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

Retrieves the distribution of email security 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 EmailSecuritySummaryV2ParamsDimension

Specifies the attribute by which to group the results.

One of the following:

const EmailSecuritySummaryV2ParamsDimensionSpam EmailSecuritySummaryV2ParamsDimension = "SPAM"

const EmailSecuritySummaryV2ParamsDimensionMalicious EmailSecuritySummaryV2ParamsDimension = "MALICIOUS"

const EmailSecuritySummaryV2ParamsDimensionSpoof EmailSecuritySummaryV2ParamsDimension = "SPOOF"

const EmailSecuritySummaryV2ParamsDimensionThreatCategory EmailSecuritySummaryV2ParamsDimension = "THREAT_CATEGORY"

const EmailSecuritySummaryV2ParamsDimensionARC EmailSecuritySummaryV2ParamsDimension = "ARC"

const EmailSecuritySummaryV2ParamsDimensionDKIM EmailSecuritySummaryV2ParamsDimension = "DKIM"

const EmailSecuritySummaryV2ParamsDimensionDMARC EmailSecuritySummaryV2ParamsDimension = "DMARC"

const EmailSecuritySummaryV2ParamsDimensionSPF EmailSecuritySummaryV2ParamsDimension = "SPF"

const EmailSecuritySummaryV2ParamsDimensionTLSVersion EmailSecuritySummaryV2ParamsDimension = "TLS_VERSION"

query EmailSecuritySummaryV2Params

ARC param.Field[[]EmailSecuritySummaryV2ParamsARC]Optional

Filters results by ARC (Authenticated Received Chain) validation.

const EmailSecuritySummaryV2ParamsARCPass EmailSecuritySummaryV2ParamsARC = "PASS"

const EmailSecuritySummaryV2ParamsARCNone EmailSecuritySummaryV2ParamsARC = "NONE"

const EmailSecuritySummaryV2ParamsARCFail EmailSecuritySummaryV2ParamsARC = "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[[]EmailSecuritySummaryV2ParamsDKIM]Optional

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

const EmailSecuritySummaryV2ParamsDKIMPass EmailSecuritySummaryV2ParamsDKIM = "PASS"

const EmailSecuritySummaryV2ParamsDKIMNone EmailSecuritySummaryV2ParamsDKIM = "NONE"

const EmailSecuritySummaryV2ParamsDKIMFail EmailSecuritySummaryV2ParamsDKIM = "FAIL"

DMARC param.Field[[]EmailSecuritySummaryV2ParamsDMARC]Optional

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

const EmailSecuritySummaryV2ParamsDMARCPass EmailSecuritySummaryV2ParamsDMARC = "PASS"

const EmailSecuritySummaryV2ParamsDMARCNone EmailSecuritySummaryV2ParamsDMARC = "NONE"

const EmailSecuritySummaryV2ParamsDMARCFail EmailSecuritySummaryV2ParamsDMARC = "FAIL"

Format param.Field[EmailSecuritySummaryV2ParamsFormat]Optional

Format in which results will be returned.

const EmailSecuritySummaryV2ParamsFormatJson EmailSecuritySummaryV2ParamsFormat = "JSON"

const EmailSecuritySummaryV2ParamsFormatCsv EmailSecuritySummaryV2ParamsFormat = "CSV"

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

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

const EmailSecuritySummaryV2ParamsSPFPass EmailSecuritySummaryV2ParamsSPF = "PASS"

const EmailSecuritySummaryV2ParamsSPFNone EmailSecuritySummaryV2ParamsSPF = "NONE"

const EmailSecuritySummaryV2ParamsSPFFail EmailSecuritySummaryV2ParamsSPF = "FAIL"

TLSVersion param.Field[[]EmailSecuritySummaryV2ParamsTLSVersion]Optional

Filters results by TLS version.

const EmailSecuritySummaryV2ParamsTLSVersionTlSv1_0 EmailSecuritySummaryV2ParamsTLSVersion = "TLSv1_0"

const EmailSecuritySummaryV2ParamsTLSVersionTlSv1_1 EmailSecuritySummaryV2ParamsTLSVersion = "TLSv1_1"

const EmailSecuritySummaryV2ParamsTLSVersionTlSv1_2 EmailSecuritySummaryV2ParamsTLSVersion = "TLSv1_2"

const EmailSecuritySummaryV2ParamsTLSVersionTlSv1_3 EmailSecuritySummaryV2ParamsTLSVersion = "TLSv1_3"

ReturnsExpand Collapse

type EmailSecuritySummaryV2Response struct{…}

Meta EmailSecuritySummaryV2ResponseMeta

Metadata for the results.

ConfidenceInfo EmailSecuritySummaryV2ResponseMetaConfidenceInfo

Annotations []EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotation

DataSource EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource

Data source for annotations.

One of the following:

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceAll EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "ALL"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceAIBots EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "AI_BOTS"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceAIGateway EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "AI_GATEWAY"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceBGP EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "BGP"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceBots EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "BOTS"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceConnectionAnomaly EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "CONNECTION_ANOMALY"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceCT EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "CT"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceDNS EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "DNS"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceDNSMagnitude EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_MAGNITUDE"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceDNSAS112 EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_AS112"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceDos EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "DOS"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceEmailRouting EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_ROUTING"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceEmailSecurity EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_SECURITY"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceFw EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "FW"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceFwPg EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "FW_PG"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceHTTP EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceHTTPControl EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CONTROL"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceHTTPCrawlerReferer EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CRAWLER_REFERER"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceHTTPOrigins EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_ORIGINS"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceIQI EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "IQI"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceLeakedCredentials EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "LEAKED_CREDENTIALS"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceNet EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "NET"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceRobotsTXT EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "ROBOTS_TXT"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceSpeed EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "SPEED"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceWorkersAI EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "WORKERS_AI"

Description string

EndDate Time

formatdate-time

EventType EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsEventType

Event type for annotations.

One of the following:

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsEventTypeEvent EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsEventType = "EVENT"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsEventTypeGeneral EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsEventType = "GENERAL"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsEventTypeOutage EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsEventType = "OUTAGE"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsEventTypePartialProjection EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsEventType = "PARTIAL_PROJECTION"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsEventTypePipeline EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsEventType = "PIPELINE"

const EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsEventTypeTrafficAnomaly EmailSecuritySummaryV2ResponseMetaConfidenceInfoAnnotationsEventType = "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 []EmailSecuritySummaryV2ResponseMetaDateRange

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 EmailSecuritySummaryV2ResponseMetaNormalization

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

One of the following:

const EmailSecuritySummaryV2ResponseMetaNormalizationPercentage EmailSecuritySummaryV2ResponseMetaNormalization = "PERCENTAGE"

const EmailSecuritySummaryV2ResponseMetaNormalizationMin0Max EmailSecuritySummaryV2ResponseMetaNormalization = "MIN0_MAX"

const EmailSecuritySummaryV2ResponseMetaNormalizationMinMax EmailSecuritySummaryV2ResponseMetaNormalization = "MIN_MAX"

const EmailSecuritySummaryV2ResponseMetaNormalizationRawValues EmailSecuritySummaryV2ResponseMetaNormalization = "RAW_VALUES"

const EmailSecuritySummaryV2ResponseMetaNormalizationPercentageChange EmailSecuritySummaryV2ResponseMetaNormalization = "PERCENTAGE_CHANGE"

const EmailSecuritySummaryV2ResponseMetaNormalizationRollingAverage EmailSecuritySummaryV2ResponseMetaNormalization = "ROLLING_AVERAGE"

const EmailSecuritySummaryV2ResponseMetaNormalizationOverlappedPercentage EmailSecuritySummaryV2ResponseMetaNormalization = "OVERLAPPED_PERCENTAGE"

const EmailSecuritySummaryV2ResponseMetaNormalizationRatio EmailSecuritySummaryV2ResponseMetaNormalization = "RATIO"