Get top locations by network traffic

client.Radar.NetFlows.Top.Locations(ctx, query) (*NetFlowsTopLocationsResponse, error)

GET/radar/netflows/top/locations

Retrieves the top locations by network traffic (NetFlows).

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 NetFlowsTopLocationsParams

ASN param.Field[[]string]Optional

Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.

Continent param.Field[[]string]Optional

Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.

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.

Format param.Field[NetFlowsTopLocationsParamsFormat]Optional

Format in which results will be returned.

const NetFlowsTopLocationsParamsFormatJson NetFlowsTopLocationsParamsFormat = "JSON"

const NetFlowsTopLocationsParamsFormatCsv NetFlowsTopLocationsParamsFormat = "CSV"

GeoID param.Field[[]string]Optional

Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).

Limit param.Field[int64]Optional

Limits the number of objects returned in the response.

exclusiveMinimum

minimum0

Location param.Field[[]string]Optional

Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.

Name param.Field[[]string]Optional

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

ReturnsExpand Collapse

type NetFlowsTopLocationsResponse struct{…}

Meta NetFlowsTopLocationsResponseMeta

Metadata for the results.

ConfidenceInfo NetFlowsTopLocationsResponseMetaConfidenceInfo

Annotations []NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotation

DataSource NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource

Data source for annotations.

One of the following:

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceAll NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "ALL"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceAIBots NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "AI_BOTS"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceAIGateway NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "AI_GATEWAY"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceBGP NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "BGP"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceBots NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "BOTS"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceConnectionAnomaly NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "CONNECTION_ANOMALY"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceCT NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "CT"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceDNS NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "DNS"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceDNSMagnitude NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_MAGNITUDE"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceDNSAS112 NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_AS112"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceDos NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "DOS"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceEmailRouting NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_ROUTING"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceEmailSecurity NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_SECURITY"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceFw NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "FW"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceFwPg NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "FW_PG"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceHTTP NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceHTTPControl NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CONTROL"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceHTTPCrawlerReferer NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CRAWLER_REFERER"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceHTTPOrigins NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_ORIGINS"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceIQI NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "IQI"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceLeakedCredentials NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "LEAKED_CREDENTIALS"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceNet NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "NET"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceRobotsTXT NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "ROBOTS_TXT"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceSpeed NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "SPEED"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSourceWorkersAI NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsDataSource = "WORKERS_AI"

Description string

EndDate Time

formatdate-time

EventType NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsEventType

Event type for annotations.

One of the following:

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsEventTypeEvent NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsEventType = "EVENT"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsEventTypeGeneral NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsEventType = "GENERAL"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsEventTypeOutage NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsEventType = "OUTAGE"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsEventTypePartialProjection NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsEventType = "PARTIAL_PROJECTION"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsEventTypePipeline NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsEventType = "PIPELINE"

const NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsEventTypeTrafficAnomaly NetFlowsTopLocationsResponseMetaConfidenceInfoAnnotationsEventType = "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 []NetFlowsTopLocationsResponseMetaDateRange

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 NetFlowsTopLocationsResponseMetaNormalization

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

One of the following:

const NetFlowsTopLocationsResponseMetaNormalizationPercentage NetFlowsTopLocationsResponseMetaNormalization = "PERCENTAGE"

const NetFlowsTopLocationsResponseMetaNormalizationMin0Max NetFlowsTopLocationsResponseMetaNormalization = "MIN0_MAX"

const NetFlowsTopLocationsResponseMetaNormalizationMinMax NetFlowsTopLocationsResponseMetaNormalization = "MIN_MAX"

const NetFlowsTopLocationsResponseMetaNormalizationRawValues NetFlowsTopLocationsResponseMetaNormalization = "RAW_VALUES"

const NetFlowsTopLocationsResponseMetaNormalizationPercentageChange NetFlowsTopLocationsResponseMetaNormalization = "PERCENTAGE_CHANGE"

const NetFlowsTopLocationsResponseMetaNormalizationRollingAverage NetFlowsTopLocationsResponseMetaNormalization = "ROLLING_AVERAGE"

const NetFlowsTopLocationsResponseMetaNormalizationOverlappedPercentage NetFlowsTopLocationsResponseMetaNormalization = "OVERLAPPED_PERCENTAGE"

const NetFlowsTopLocationsResponseMetaNormalizationRatio NetFlowsTopLocationsResponseMetaNormalization = "RATIO"

Units []NetFlowsTopLocationsResponseMetaUnit

Measurement units for the results.

Name string

Value string

Top0 []NetFlowsTopLocationsResponseTop0

ClientCountryAlpha2 string

ClientCountryName string

Value string

A numeric string.

Get top locations by network traffic

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.NetFlows.Top.Locations(context.TODO(), radar.NetFlowsTopLocationsParams{

  })
  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"
        }
      ]
    },
    "top_0": [
      {
        "clientCountryAlpha2": "US",
        "clientCountryName": "United States",
        "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",
            "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"
        }
      ]
    },
    "top_0": [
      {
        "clientCountryAlpha2": "US",
        "clientCountryName": "United States",
        "value": "10"
      }
    ]
  },
  "success": true
}