Get top user agent families by HTTP requests

Deprecated

client.Radar.HTTP.Top.BrowserFamily(ctx, query) (*HTTPTopBrowserFamilyResponse, error)

GET/radar/http/top/browser_family

Retrieves the top user agents, aggregated in families, by HTTP requests.

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 HTTPTopBrowserFamilyParams

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.

BotClass param.Field[[]HTTPTopBrowserFamilyParamsBotClass]optional

Filters results by bot class. Refer to Bot classes.

const HTTPTopBrowserFamilyParamsBotClassLikelyAutomated HTTPTopBrowserFamilyParamsBotClass = "LIKELY_AUTOMATED"

const HTTPTopBrowserFamilyParamsBotClassLikelyHuman HTTPTopBrowserFamilyParamsBotClass = "LIKELY_HUMAN"

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.

DeviceType param.Field[[]HTTPTopBrowserFamilyParamsDeviceType]optional

Filters results by device type.

const HTTPTopBrowserFamilyParamsDeviceTypeDesktop HTTPTopBrowserFamilyParamsDeviceType = "DESKTOP"

const HTTPTopBrowserFamilyParamsDeviceTypeMobile HTTPTopBrowserFamilyParamsDeviceType = "MOBILE"

const HTTPTopBrowserFamilyParamsDeviceTypeOther HTTPTopBrowserFamilyParamsDeviceType = "OTHER"

Format param.Field[HTTPTopBrowserFamilyParamsFormat]optional

Format in which results will be returned.

const HTTPTopBrowserFamilyParamsFormatJson HTTPTopBrowserFamilyParamsFormat = "JSON"

const HTTPTopBrowserFamilyParamsFormatCsv HTTPTopBrowserFamilyParamsFormat = "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).

HTTPProtocol param.Field[[]HTTPTopBrowserFamilyParamsHTTPProtocol]optional

Filters results by HTTP protocol (HTTP vs. HTTPS).

const HTTPTopBrowserFamilyParamsHTTPProtocolHTTP HTTPTopBrowserFamilyParamsHTTPProtocol = "HTTP"

const HTTPTopBrowserFamilyParamsHTTPProtocolHTTPS HTTPTopBrowserFamilyParamsHTTPProtocol = "HTTPS"

HTTPVersion param.Field[[]HTTPTopBrowserFamilyParamsHTTPVersion]optional

Filters results by HTTP version.

const HTTPTopBrowserFamilyParamsHTTPVersionHttPv1 HTTPTopBrowserFamilyParamsHTTPVersion = "HTTPv1"

const HTTPTopBrowserFamilyParamsHTTPVersionHttPv2 HTTPTopBrowserFamilyParamsHTTPVersion = "HTTPv2"

const HTTPTopBrowserFamilyParamsHTTPVersionHttPv3 HTTPTopBrowserFamilyParamsHTTPVersion = "HTTPv3"

IPVersion param.Field[[]HTTPTopBrowserFamilyParamsIPVersion]optional

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

const HTTPTopBrowserFamilyParamsIPVersionIPv4 HTTPTopBrowserFamilyParamsIPVersion = "IPv4"

const HTTPTopBrowserFamilyParamsIPVersionIPv6 HTTPTopBrowserFamilyParamsIPVersion = "IPv6"

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.

OS param.Field[[]HTTPTopBrowserFamilyParamsOS]optional

Filters results by operating system.

const HTTPTopBrowserFamilyParamsOSWindows HTTPTopBrowserFamilyParamsOS = "WINDOWS"

const HTTPTopBrowserFamilyParamsOSMacosx HTTPTopBrowserFamilyParamsOS = "MACOSX"

const HTTPTopBrowserFamilyParamsOSIos HTTPTopBrowserFamilyParamsOS = "IOS"

const HTTPTopBrowserFamilyParamsOSAndroid HTTPTopBrowserFamilyParamsOS = "ANDROID"

const HTTPTopBrowserFamilyParamsOSChromeos HTTPTopBrowserFamilyParamsOS = "CHROMEOS"

const HTTPTopBrowserFamilyParamsOSLinux HTTPTopBrowserFamilyParamsOS = "LINUX"

const HTTPTopBrowserFamilyParamsOSSmartTv HTTPTopBrowserFamilyParamsOS = "SMART_TV"

TLSVersion param.Field[[]HTTPTopBrowserFamilyParamsTLSVersion]optional

Filters results by TLS version.

const HTTPTopBrowserFamilyParamsTLSVersionTlSv1_0 HTTPTopBrowserFamilyParamsTLSVersion = "TLSv1_0"

const HTTPTopBrowserFamilyParamsTLSVersionTlSv1_1 HTTPTopBrowserFamilyParamsTLSVersion = "TLSv1_1"

const HTTPTopBrowserFamilyParamsTLSVersionTlSv1_2 HTTPTopBrowserFamilyParamsTLSVersion = "TLSv1_2"

const HTTPTopBrowserFamilyParamsTLSVersionTlSv1_3 HTTPTopBrowserFamilyParamsTLSVersion = "TLSv1_3"

const HTTPTopBrowserFamilyParamsTLSVersionTlSvQuic HTTPTopBrowserFamilyParamsTLSVersion = "TLSvQUIC"

ReturnsExpand Collapse

type HTTPTopBrowserFamilyResponse struct{…}

Meta HTTPTopBrowserFamilyResponseMeta

Metadata for the results.

ConfidenceInfo HTTPTopBrowserFamilyResponseMetaConfidenceInfo

Annotations []HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotation

DataSource HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource

Data source for annotations.

One of the following:

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceAll HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "ALL"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceAIBots HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "AI_BOTS"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceAIGateway HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "AI_GATEWAY"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceBGP HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "BGP"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceBots HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "BOTS"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceConnectionAnomaly HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "CONNECTION_ANOMALY"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceCT HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "CT"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceDNS HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "DNS"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceDNSMagnitude HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_MAGNITUDE"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceDNSAS112 HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_AS112"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceDos HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "DOS"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceEmailRouting HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_ROUTING"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceEmailSecurity HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_SECURITY"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceFw HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "FW"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceFwPg HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "FW_PG"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceHTTP HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceHTTPControl HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CONTROL"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceHTTPCrawlerReferer HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CRAWLER_REFERER"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceHTTPOrigins HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_ORIGINS"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceIQI HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "IQI"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceLeakedCredentials HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "LEAKED_CREDENTIALS"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceNet HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "NET"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceRobotsTXT HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "ROBOTS_TXT"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceSpeed HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "SPEED"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSourceWorkersAI HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsDataSource = "WORKERS_AI"

Description string

EndDate Time

formatdate-time

EventType HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsEventType

Event type for annotations.

One of the following:

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsEventTypeEvent HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsEventType = "EVENT"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsEventTypeGeneral HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsEventType = "GENERAL"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsEventTypeOutage HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsEventType = "OUTAGE"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsEventTypePartialProjection HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsEventType = "PARTIAL_PROJECTION"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsEventTypePipeline HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsEventType = "PIPELINE"

const HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsEventTypeTrafficAnomaly HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotationsEventType = "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 []HTTPTopBrowserFamilyResponseMetaDateRange

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 HTTPTopBrowserFamilyResponseMetaNormalization

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

One of the following:

const HTTPTopBrowserFamilyResponseMetaNormalizationPercentage HTTPTopBrowserFamilyResponseMetaNormalization = "PERCENTAGE"

const HTTPTopBrowserFamilyResponseMetaNormalizationMin0Max HTTPTopBrowserFamilyResponseMetaNormalization = "MIN0_MAX"

const HTTPTopBrowserFamilyResponseMetaNormalizationMinMax HTTPTopBrowserFamilyResponseMetaNormalization = "MIN_MAX"

const HTTPTopBrowserFamilyResponseMetaNormalizationRawValues HTTPTopBrowserFamilyResponseMetaNormalization = "RAW_VALUES"

const HTTPTopBrowserFamilyResponseMetaNormalizationPercentageChange HTTPTopBrowserFamilyResponseMetaNormalization = "PERCENTAGE_CHANGE"

const HTTPTopBrowserFamilyResponseMetaNormalizationRollingAverage HTTPTopBrowserFamilyResponseMetaNormalization = "ROLLING_AVERAGE"

const HTTPTopBrowserFamilyResponseMetaNormalizationOverlappedPercentage HTTPTopBrowserFamilyResponseMetaNormalization = "OVERLAPPED_PERCENTAGE"

const HTTPTopBrowserFamilyResponseMetaNormalizationRatio HTTPTopBrowserFamilyResponseMetaNormalization = "RATIO"

Units []HTTPTopBrowserFamilyResponseMetaUnit

Measurement units for the results.

Name string

Value string

Top0 []HTTPTopBrowserFamilyResponseTop0

Name string

Value string

Get top user agent families by HTTP requests

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"),
  )
  response, err := client.Radar.HTTP.Top.BrowserFamily(context.TODO(), radar.HTTPTopBrowserFamilyParams{

  })
  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"
          }
        ],
        "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": "chrome",
        "value": "value"
      }
    ]
  },
  "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": "chrome",
        "value": "value"
      }
    ]
  },
  "success": true
}