Get top TLDs by email message volume

client.Radar.Email.Security.Top.TLDs.Get(ctx, query) (*EmailSecurityTopTLDGetResponse, error)

GET/radar/email/security/top/tlds

Retrieves the top TLDs by number of email messages.

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 EmailSecurityTopTLDGetParams

ARC param.Field[[]EmailSecurityTopTLDGetParamsARC]optional

Filters results by ARC (Authenticated Received Chain) validation.

const EmailSecurityTopTLDGetParamsARCPass EmailSecurityTopTLDGetParamsARC = "PASS"

const EmailSecurityTopTLDGetParamsARCNone EmailSecurityTopTLDGetParamsARC = "NONE"

const EmailSecurityTopTLDGetParamsARCFail EmailSecurityTopTLDGetParamsARC = "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[[]EmailSecurityTopTLDGetParamsDKIM]optional

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

const EmailSecurityTopTLDGetParamsDKIMPass EmailSecurityTopTLDGetParamsDKIM = "PASS"

const EmailSecurityTopTLDGetParamsDKIMNone EmailSecurityTopTLDGetParamsDKIM = "NONE"

const EmailSecurityTopTLDGetParamsDKIMFail EmailSecurityTopTLDGetParamsDKIM = "FAIL"

DMARC param.Field[[]EmailSecurityTopTLDGetParamsDMARC]optional

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

const EmailSecurityTopTLDGetParamsDMARCPass EmailSecurityTopTLDGetParamsDMARC = "PASS"

const EmailSecurityTopTLDGetParamsDMARCNone EmailSecurityTopTLDGetParamsDMARC = "NONE"

const EmailSecurityTopTLDGetParamsDMARCFail EmailSecurityTopTLDGetParamsDMARC = "FAIL"

Format param.Field[EmailSecurityTopTLDGetParamsFormat]optional

Format in which results will be returned.

const EmailSecurityTopTLDGetParamsFormatJson EmailSecurityTopTLDGetParamsFormat = "JSON"

const EmailSecurityTopTLDGetParamsFormatCsv EmailSecurityTopTLDGetParamsFormat = "CSV"

Limit param.Field[int64]optional

Limits the number of objects returned in the response.

exclusiveMinimum

minimum0

Name param.Field[[]string]optional

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

SPF param.Field[[]EmailSecurityTopTLDGetParamsSPF]optional

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

const EmailSecurityTopTLDGetParamsSPFPass EmailSecurityTopTLDGetParamsSPF = "PASS"

const EmailSecurityTopTLDGetParamsSPFNone EmailSecurityTopTLDGetParamsSPF = "NONE"

const EmailSecurityTopTLDGetParamsSPFFail EmailSecurityTopTLDGetParamsSPF = "FAIL"

TLDCategory param.Field[EmailSecurityTopTLDGetParamsTLDCategory]optional

Filters results by TLD category.

const EmailSecurityTopTLDGetParamsTLDCategoryClassic EmailSecurityTopTLDGetParamsTLDCategory = "CLASSIC"

const EmailSecurityTopTLDGetParamsTLDCategoryCountry EmailSecurityTopTLDGetParamsTLDCategory = "COUNTRY"

TLSVersion param.Field[[]EmailSecurityTopTLDGetParamsTLSVersion]optional

Filters results by TLS version.

const EmailSecurityTopTLDGetParamsTLSVersionTlSv1_0 EmailSecurityTopTLDGetParamsTLSVersion = "TLSv1_0"

const EmailSecurityTopTLDGetParamsTLSVersionTlSv1_1 EmailSecurityTopTLDGetParamsTLSVersion = "TLSv1_1"

const EmailSecurityTopTLDGetParamsTLSVersionTlSv1_2 EmailSecurityTopTLDGetParamsTLSVersion = "TLSv1_2"

const EmailSecurityTopTLDGetParamsTLSVersionTlSv1_3 EmailSecurityTopTLDGetParamsTLSVersion = "TLSv1_3"

ReturnsExpand Collapse

type EmailSecurityTopTLDGetResponse struct{…}

Meta EmailSecurityTopTLDGetResponseMeta

Metadata for the results.

ConfidenceInfo EmailSecurityTopTLDGetResponseMetaConfidenceInfo

Annotations []EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotation

DataSource EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource

Data source for annotations.

One of the following:

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceAll EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "ALL"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceAIBots EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "AI_BOTS"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceAIGateway EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "AI_GATEWAY"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceBGP EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "BGP"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceBots EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "BOTS"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceConnectionAnomaly EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "CONNECTION_ANOMALY"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceCT EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "CT"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceDNS EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "DNS"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceDNSMagnitude EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_MAGNITUDE"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceDNSAS112 EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_AS112"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceDos EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "DOS"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceEmailRouting EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_ROUTING"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceEmailSecurity EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_SECURITY"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceFw EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "FW"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceFwPg EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "FW_PG"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceHTTP EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceHTTPControl EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CONTROL"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceHTTPCrawlerReferer EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CRAWLER_REFERER"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceHTTPOrigins EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_ORIGINS"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceIQI EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "IQI"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceLeakedCredentials EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "LEAKED_CREDENTIALS"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceNet EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "NET"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceRobotsTXT EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "ROBOTS_TXT"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceSpeed EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "SPEED"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSourceWorkersAI EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsDataSource = "WORKERS_AI"

Description string

EndDate Time

formatdate-time

EventType EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsEventType

Event type for annotations.

One of the following:

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsEventTypeEvent EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsEventType = "EVENT"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsEventTypeGeneral EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsEventType = "GENERAL"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsEventTypeOutage EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsEventType = "OUTAGE"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsEventTypePartialProjection EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsEventType = "PARTIAL_PROJECTION"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsEventTypePipeline EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsEventType = "PIPELINE"

const EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsEventTypeTrafficAnomaly EmailSecurityTopTLDGetResponseMetaConfidenceInfoAnnotationsEventType = "TRAFFIC_ANOMALY"

IsInstantaneous bool

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

LinkedURL string

formaturi

StartDate Time

formatdate-time

Level int64

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

DateRange []EmailSecurityTopTLDGetResponseMetaDateRange

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 EmailSecurityTopTLDGetResponseMetaNormalization

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

One of the following:

const EmailSecurityTopTLDGetResponseMetaNormalizationPercentage EmailSecurityTopTLDGetResponseMetaNormalization = "PERCENTAGE"

const EmailSecurityTopTLDGetResponseMetaNormalizationMin0Max EmailSecurityTopTLDGetResponseMetaNormalization = "MIN0_MAX"

const EmailSecurityTopTLDGetResponseMetaNormalizationMinMax EmailSecurityTopTLDGetResponseMetaNormalization = "MIN_MAX"

const EmailSecurityTopTLDGetResponseMetaNormalizationRawValues EmailSecurityTopTLDGetResponseMetaNormalization = "RAW_VALUES"

const EmailSecurityTopTLDGetResponseMetaNormalizationPercentageChange EmailSecurityTopTLDGetResponseMetaNormalization = "PERCENTAGE_CHANGE"

const EmailSecurityTopTLDGetResponseMetaNormalizationRollingAverage EmailSecurityTopTLDGetResponseMetaNormalization = "ROLLING_AVERAGE"

const EmailSecurityTopTLDGetResponseMetaNormalizationOverlappedPercentage EmailSecurityTopTLDGetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE"

const EmailSecurityTopTLDGetResponseMetaNormalizationRatio EmailSecurityTopTLDGetResponseMetaNormalization = "RATIO"

Units []EmailSecurityTopTLDGetResponseMetaUnit

Measurement units for the results.

Name string

Value string

Top0 []EmailSecurityTopTLDGetResponseTop0

Name string

Value string

A numeric string.

Get top TLDs by email message volume

package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  tld, err := client.Radar.Email.Security.Top.TLDs.Get(context.TODO(), radar.EmailSecurityTopTLDGetParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", tld.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"
          }
        ],
        "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"
        }
      ]
    },
    "top_0": [
      {
        "name": "com.",
        "value": "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"
          }
        ],
        "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"
        }
      ]
    },
    "top_0": [
      {
        "name": "com.",
        "value": "10"
      }
    ]
  },
  "success": true
}