Get TCP resets and timeouts summary

client.Radar.TCPResetsTimeouts.Summary(ctx, query) (*TCPResetsTimeoutSummaryResponse, error)

GET/radar/tcp_resets_timeouts/summary

Retrieves the distribution of connection stage by TCP connections terminated within the first 10 packets by a reset or timeout.

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 TCPResetsTimeoutSummaryParams

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[TCPResetsTimeoutSummaryParamsFormat]optional

Format in which results will be returned.

const TCPResetsTimeoutSummaryParamsFormatJson TCPResetsTimeoutSummaryParamsFormat = "JSON"

const TCPResetsTimeoutSummaryParamsFormatCsv TCPResetsTimeoutSummaryParamsFormat = "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 TCPResetsTimeoutSummaryResponse struct{…}

Meta TCPResetsTimeoutSummaryResponseMeta

Metadata for the results.

ConfidenceInfo TCPResetsTimeoutSummaryResponseMetaConfidenceInfo

Annotations []TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotation

DataSource TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource

Data source for annotations.

One of the following:

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceAll TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "ALL"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceAIBots TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "AI_BOTS"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceAIGateway TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "AI_GATEWAY"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceBGP TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "BGP"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceBots TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "BOTS"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceConnectionAnomaly TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "CONNECTION_ANOMALY"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceCT TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "CT"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceDNS TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "DNS"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceDNSMagnitude TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_MAGNITUDE"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceDNSAS112 TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_AS112"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceDos TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "DOS"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceEmailRouting TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_ROUTING"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceEmailSecurity TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_SECURITY"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceFw TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "FW"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceFwPg TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "FW_PG"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceHTTP TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceHTTPControl TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CONTROL"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceHTTPCrawlerReferer TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CRAWLER_REFERER"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceHTTPOrigins TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_ORIGINS"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceIQI TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "IQI"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceLeakedCredentials TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "LEAKED_CREDENTIALS"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceNet TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "NET"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceRobotsTXT TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "ROBOTS_TXT"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceSpeed TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "SPEED"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSourceWorkersAI TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsDataSource = "WORKERS_AI"

Description string

EndDate Time

formatdate-time

EventType TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsEventType

Event type for annotations.

One of the following:

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsEventTypeEvent TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsEventType = "EVENT"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsEventTypeGeneral TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsEventType = "GENERAL"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsEventTypeOutage TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsEventType = "OUTAGE"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsEventTypePartialProjection TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsEventType = "PARTIAL_PROJECTION"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsEventTypePipeline TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsEventType = "PIPELINE"

const TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsEventTypeTrafficAnomaly TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationsEventType = "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 []TCPResetsTimeoutSummaryResponseMetaDateRange

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 TCPResetsTimeoutSummaryResponseMetaNormalization

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

One of the following:

const TCPResetsTimeoutSummaryResponseMetaNormalizationPercentage TCPResetsTimeoutSummaryResponseMetaNormalization = "PERCENTAGE"

const TCPResetsTimeoutSummaryResponseMetaNormalizationMin0Max TCPResetsTimeoutSummaryResponseMetaNormalization = "MIN0_MAX"

const TCPResetsTimeoutSummaryResponseMetaNormalizationMinMax TCPResetsTimeoutSummaryResponseMetaNormalization = "MIN_MAX"

const TCPResetsTimeoutSummaryResponseMetaNormalizationRawValues TCPResetsTimeoutSummaryResponseMetaNormalization = "RAW_VALUES"

const TCPResetsTimeoutSummaryResponseMetaNormalizationPercentageChange TCPResetsTimeoutSummaryResponseMetaNormalization = "PERCENTAGE_CHANGE"

const TCPResetsTimeoutSummaryResponseMetaNormalizationRollingAverage TCPResetsTimeoutSummaryResponseMetaNormalization = "ROLLING_AVERAGE"

const TCPResetsTimeoutSummaryResponseMetaNormalizationOverlappedPercentage TCPResetsTimeoutSummaryResponseMetaNormalization = "OVERLAPPED_PERCENTAGE"

const TCPResetsTimeoutSummaryResponseMetaNormalizationRatio TCPResetsTimeoutSummaryResponseMetaNormalization = "RATIO"

Units []TCPResetsTimeoutSummaryResponseMetaUnit

Measurement units for the results.

Name string

Value string

Summary0 TCPResetsTimeoutSummaryResponseSummary0

LaterInFlow string

Connection resets within the first 10 packets from the client, but after the server has received multiple data packets.

NoMatch string

All other connections.

PostAck string

Connection resets or timeouts after the server received both a SYN packet and an ACK packet, meaning the connection was successfully established.

PostPsh string

Connection resets or timeouts after the server received a packet with PSH flag set, following connection establishment.

PostSyn string

Connection resets or timeouts after the server received only a single SYN packet.

Get TCP resets and timeouts 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.TCPResetsTimeouts.Summary(context.TODO(), radar.TCPResetsTimeoutSummaryParams{

  })
  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"
        }
      ]
    },
    "summary_0": {
      "later_in_flow": "10",
      "no_match": "65",
      "post_ack": "5",
      "post_psh": "10",
      "post_syn": "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"
        }
      ]
    },
    "summary_0": {
      "later_in_flow": "10",
      "no_match": "65",
      "post_ack": "5",
      "post_psh": "10",
      "post_syn": "10"
    }
  },
  "success": true
}