Get speed tests summary

client.Radar.Quality.Speed.Summary(ctx, query) (*QualitySpeedSummaryResponse, error)

GET/radar/quality/speed/summary

Retrieves a summary of bandwidth, latency, jitter, and packet loss, from the previous 90 days of Cloudflare Speed Test data.

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 QualitySpeedSummaryParams

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).

Format param.Field[QualitySpeedSummaryParamsFormat]Optional

Format in which results will be returned.

const QualitySpeedSummaryParamsFormatJson QualitySpeedSummaryParamsFormat = "JSON"

const QualitySpeedSummaryParamsFormatCsv QualitySpeedSummaryParamsFormat = "CSV"

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 QualitySpeedSummaryResponse struct{…}

Meta QualitySpeedSummaryResponseMeta

Metadata for the results.

ConfidenceInfo QualitySpeedSummaryResponseMetaConfidenceInfo

Annotations []QualitySpeedSummaryResponseMetaConfidenceInfoAnnotation

DataSource QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource

Data source for annotations.

One of the following:

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceAll QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "ALL"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceAIBots QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "AI_BOTS"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceAIGateway QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "AI_GATEWAY"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceBGP QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "BGP"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceBots QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "BOTS"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceConnectionAnomaly QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "CONNECTION_ANOMALY"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceCT QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "CT"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceDNS QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "DNS"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceDNSMagnitude QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_MAGNITUDE"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceDNSAS112 QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_AS112"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceDos QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "DOS"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceEmailRouting QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_ROUTING"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceEmailSecurity QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_SECURITY"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceFw QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "FW"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceFwPg QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "FW_PG"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceHTTP QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceHTTPControl QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CONTROL"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceHTTPCrawlerReferer QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CRAWLER_REFERER"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceHTTPOrigins QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_ORIGINS"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceIQI QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "IQI"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceLeakedCredentials QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "LEAKED_CREDENTIALS"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceNet QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "NET"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceRobotsTXT QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "ROBOTS_TXT"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceSpeed QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "SPEED"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSourceWorkersAI QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "WORKERS_AI"

Description string

EndDate Time

formatdate-time

EventType QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsEventType

Event type for annotations.

One of the following:

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsEventTypeEvent QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsEventType = "EVENT"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsEventTypeGeneral QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsEventType = "GENERAL"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsEventTypeOutage QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsEventType = "OUTAGE"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsEventTypePartialProjection QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsEventType = "PARTIAL_PROJECTION"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsEventTypePipeline QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsEventType = "PIPELINE"

const QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsEventTypeTrafficAnomaly QualitySpeedSummaryResponseMetaConfidenceInfoAnnotationsEventType = "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 []QualitySpeedSummaryResponseMetaDateRange

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 QualitySpeedSummaryResponseMetaNormalization

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

One of the following:

const QualitySpeedSummaryResponseMetaNormalizationPercentage QualitySpeedSummaryResponseMetaNormalization = "PERCENTAGE"

const QualitySpeedSummaryResponseMetaNormalizationMin0Max QualitySpeedSummaryResponseMetaNormalization = "MIN0_MAX"

const QualitySpeedSummaryResponseMetaNormalizationMinMax QualitySpeedSummaryResponseMetaNormalization = "MIN_MAX"

const QualitySpeedSummaryResponseMetaNormalizationRawValues QualitySpeedSummaryResponseMetaNormalization = "RAW_VALUES"

const QualitySpeedSummaryResponseMetaNormalizationPercentageChange QualitySpeedSummaryResponseMetaNormalization = "PERCENTAGE_CHANGE"

const QualitySpeedSummaryResponseMetaNormalizationRollingAverage QualitySpeedSummaryResponseMetaNormalization = "ROLLING_AVERAGE"

const QualitySpeedSummaryResponseMetaNormalizationOverlappedPercentage QualitySpeedSummaryResponseMetaNormalization = "OVERLAPPED_PERCENTAGE"

const QualitySpeedSummaryResponseMetaNormalizationRatio QualitySpeedSummaryResponseMetaNormalization = "RATIO"

Units []QualitySpeedSummaryResponseMetaUnit

Measurement units for the results.

Name string

Value string

Summary0 QualitySpeedSummaryResponseSummary0

BandwidthDownload string

BandwidthUpload string

JitterIdle string

JitterLoaded string

LatencyIdle string

LatencyLoaded string

PacketLoss string

Get speed tests summary

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.Quality.Speed.Summary(context.TODO(), radar.QualitySpeedSummaryParams{

  })
  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": {
      "bandwidthDownload": "83.765201",
      "bandwidthUpload": "39.005561",
      "jitterIdle": "25.648713",
      "jitterLoaded": "77.462155",
      "latencyIdle": "83.165385",
      "latencyLoaded": "270.561124",
      "packetLoss": "1.23705"
    }
  },
  "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": {
      "bandwidthDownload": "83.765201",
      "bandwidthUpload": "39.005561",
      "jitterIdle": "25.648713",
      "jitterLoaded": "77.462155",
      "latencyIdle": "83.165385",
      "latencyLoaded": "270.561124",
      "packetLoss": "1.23705"
    }
  },
  "success": true
}