Get HTTP requests by OS summary

client.Radar.HTTP.Summary.OS(ctx, query) (*HTTPSummaryOSResponse, error)

GET/radar/http/summary/os

Retrieves the distribution of HTTP requests by operating system (Windows, macOS, Android, iOS, and others).

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 HTTPSummaryOSParams

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

Filters results by bot class. Refer to Bot classes.

const HTTPSummaryOSParamsBotClassLikelyAutomated HTTPSummaryOSParamsBotClass = "LIKELY_AUTOMATED"

const HTTPSummaryOSParamsBotClassLikelyHuman HTTPSummaryOSParamsBotClass = "LIKELY_HUMAN"

BrowserFamily param.Field[[]HTTPSummaryOSParamsBrowserFamily]Optional

Filters results by browser family.

const HTTPSummaryOSParamsBrowserFamilyChrome HTTPSummaryOSParamsBrowserFamily = "CHROME"

const HTTPSummaryOSParamsBrowserFamilyEdge HTTPSummaryOSParamsBrowserFamily = "EDGE"

const HTTPSummaryOSParamsBrowserFamilyFirefox HTTPSummaryOSParamsBrowserFamily = "FIREFOX"

const HTTPSummaryOSParamsBrowserFamilySafari HTTPSummaryOSParamsBrowserFamily = "SAFARI"

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). Alternative to dateRange; provide together with dateStart. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.

DateRange param.Field[[]string]Optional

Filters results by relative date range ending at the current time, with each value producing a separate series. Use <n>d for days (up to 364d) or <n>w for weeks (up to 52w). Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window’s length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 7dcontrol covers days -14 to -7, 10dcontrol covers days -24 to -14). For example, pass 7d and 7dcontrol to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including control) satisfy this automatically. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).

DateStart param.Field[[]Time]Optional

Start of the date range. Alternative to dateRange; provide together with dateEnd. When requesting comparison series, every series must resolve to the same duration as the main series. Each dateStart/dateEnd is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.

DeviceType param.Field[[]HTTPSummaryOSParamsDeviceType]Optional

Filters results by device type.

const HTTPSummaryOSParamsDeviceTypeDesktop HTTPSummaryOSParamsDeviceType = "DESKTOP"

const HTTPSummaryOSParamsDeviceTypeMobile HTTPSummaryOSParamsDeviceType = "MOBILE"

const HTTPSummaryOSParamsDeviceTypeOther HTTPSummaryOSParamsDeviceType = "OTHER"

Format param.Field[HTTPSummaryOSParamsFormat]Optional

Format in which results will be returned.

const HTTPSummaryOSParamsFormatJson HTTPSummaryOSParamsFormat = "JSON"

const HTTPSummaryOSParamsFormatCsv HTTPSummaryOSParamsFormat = "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[[]HTTPSummaryOSParamsHTTPProtocol]Optional

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

const HTTPSummaryOSParamsHTTPProtocolHTTP HTTPSummaryOSParamsHTTPProtocol = "HTTP"

const HTTPSummaryOSParamsHTTPProtocolHTTPS HTTPSummaryOSParamsHTTPProtocol = "HTTPS"

HTTPVersion param.Field[[]HTTPSummaryOSParamsHTTPVersion]Optional

Filters results by HTTP version.

const HTTPSummaryOSParamsHTTPVersionHttPv1 HTTPSummaryOSParamsHTTPVersion = "HTTPv1"

const HTTPSummaryOSParamsHTTPVersionHttPv2 HTTPSummaryOSParamsHTTPVersion = "HTTPv2"

const HTTPSummaryOSParamsHTTPVersionHttPv3 HTTPSummaryOSParamsHTTPVersion = "HTTPv3"

IPVersion param.Field[[]HTTPSummaryOSParamsIPVersion]Optional

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

const HTTPSummaryOSParamsIPVersionIPv4 HTTPSummaryOSParamsIPVersion = "IPv4"

const HTTPSummaryOSParamsIPVersionIPv6 HTTPSummaryOSParamsIPVersion = "IPv6"

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.

TLSVersion param.Field[[]HTTPSummaryOSParamsTLSVersion]Optional

Filters results by TLS version.

const HTTPSummaryOSParamsTLSVersionTlSv1_0 HTTPSummaryOSParamsTLSVersion = "TLSv1_0"

const HTTPSummaryOSParamsTLSVersionTlSv1_1 HTTPSummaryOSParamsTLSVersion = "TLSv1_1"

const HTTPSummaryOSParamsTLSVersionTlSv1_2 HTTPSummaryOSParamsTLSVersion = "TLSv1_2"

const HTTPSummaryOSParamsTLSVersionTlSv1_3 HTTPSummaryOSParamsTLSVersion = "TLSv1_3"

const HTTPSummaryOSParamsTLSVersionTlSvQuic HTTPSummaryOSParamsTLSVersion = "TLSvQUIC"

ReturnsExpand Collapse

type HTTPSummaryOSResponse struct{…}

Meta HTTPSummaryOSResponseMeta

Metadata for the results.

ConfidenceInfo HTTPSummaryOSResponseMetaConfidenceInfo

Annotations []HTTPSummaryOSResponseMetaConfidenceInfoAnnotation

DataSource HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource

Data source for annotations.

One of the following:

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceAll HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "ALL"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceAIBots HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "AI_BOTS"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceAIGateway HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "AI_GATEWAY"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceBGP HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "BGP"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceBots HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "BOTS"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceConnectionAnomaly HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "CONNECTION_ANOMALY"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceCT HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "CT"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceDNS HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "DNS"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceDNSMagnitude HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_MAGNITUDE"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceDNSAS112 HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_AS112"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceDos HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "DOS"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceEmailRouting HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_ROUTING"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceEmailSecurity HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_SECURITY"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceFw HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "FW"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceFwPg HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "FW_PG"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceHTTP HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceHTTPControl HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CONTROL"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceHTTPCrawlerReferer HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CRAWLER_REFERER"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceHTTPOrigins HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_ORIGINS"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceIQI HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "IQI"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceLeakedCredentials HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "LEAKED_CREDENTIALS"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceNet HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "NET"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceRobotsTXT HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "ROBOTS_TXT"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceSpeed HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "SPEED"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSourceWorkersAI HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsDataSource = "WORKERS_AI"

Description string

EndDate Time

formatdate-time

EventType HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsEventType

Event type for annotations.

One of the following:

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsEventTypeEvent HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsEventType = "EVENT"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsEventTypeGeneral HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsEventType = "GENERAL"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsEventTypeOutage HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsEventType = "OUTAGE"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsEventTypePartialProjection HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsEventType = "PARTIAL_PROJECTION"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsEventTypePipeline HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsEventType = "PIPELINE"

const HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsEventTypeTrafficAnomaly HTTPSummaryOSResponseMetaConfidenceInfoAnnotationsEventType = "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 []HTTPSummaryOSResponseMetaDateRange

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 HTTPSummaryOSResponseMetaNormalization

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

One of the following:

const HTTPSummaryOSResponseMetaNormalizationPercentage HTTPSummaryOSResponseMetaNormalization = "PERCENTAGE"

const HTTPSummaryOSResponseMetaNormalizationMin0Max HTTPSummaryOSResponseMetaNormalization = "MIN0_MAX"

const HTTPSummaryOSResponseMetaNormalizationMinMax HTTPSummaryOSResponseMetaNormalization = "MIN_MAX"

const HTTPSummaryOSResponseMetaNormalizationRawValues HTTPSummaryOSResponseMetaNormalization = "RAW_VALUES"

const HTTPSummaryOSResponseMetaNormalizationPercentageChange HTTPSummaryOSResponseMetaNormalization = "PERCENTAGE_CHANGE"

const HTTPSummaryOSResponseMetaNormalizationRollingAverage HTTPSummaryOSResponseMetaNormalization = "ROLLING_AVERAGE"

const HTTPSummaryOSResponseMetaNormalizationOverlappedPercentage HTTPSummaryOSResponseMetaNormalization = "OVERLAPPED_PERCENTAGE"

const HTTPSummaryOSResponseMetaNormalizationRatio HTTPSummaryOSResponseMetaNormalization = "RATIO"

Units []HTTPSummaryOSResponseMetaUnit

Measurement units for the results.

Name string

Value string

Summary0 HTTPSummaryOSResponseSummary0

Android string

A numeric string.

Ios string

A numeric string.

Get HTTP requests by OS summary

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.Summary.OS(context.TODO(), radar.HTTPSummaryOSParams{

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