Language

English Français 日本語 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 US1-FED

Cloud Network Monitoring

The Cloud Network Monitoring API allows you to fetch aggregated connections and their attributes. See the Cloud Network Monitoring page for more information.

Get aggregated connections

Note: This endpoint is in Preview. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/network/connections/aggregatehttps://api.datadoghq.eu/api/v2/network/connections/aggregatehttps://api.ddog-gov.com/api/v2/network/connections/aggregatehttps://api.datadoghq.com/api/v2/network/connections/aggregatehttps://api.us3.datadoghq.com/api/v2/network/connections/aggregatehttps://api.us5.datadoghq.com/api/v2/network/connections/aggregate

Overview

Get aggregated connections

Arguments

Query Strings

Name

Type

Description

from

integer

Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window is 15 minutes before the “to” timestamp. If neither “from” nor “to” are provided, the query window is [now - 15m, now].

to

integer

Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window is the current time. If neither “from” nor “to” are provided, the query window is [now - 15m, now].

group_by

string

Comma-separated list of fields to group connections by.

tags

string

Comma-separated list of tags to filter connections by.

limit

integer

The number of connections to be returned. The maximum value is 5000.

Response

OK

The definition of SingleAggregatedConnectionResponseArray object.

Expand All

Field

Type

Description

data

[object]

The SingleAggregatedConnectionResponseArray data.

attributes

object

The definition of SingleAggregatedConnectionResponseDataAttributes object.

bytes_sent_by_client

int64

The total number of bytes sent by the client over the given period.

bytes_sent_by_server

int64

The total number of bytes sent by the server over the given period.

group_bys

object

The attributes group_bys.

<any-key>

[string]

packets_sent_by_client

int64

The total number of packets sent by the client over the given period.

packets_sent_by_server

int64

The total number of packets sent by the server over the given period.

rtt_micro_seconds

int64

Measured as TCP smoothed round trip time in microseconds (the time between a TCP frame being sent and acknowledged).

tcp_closed_connections

int64

The number of TCP connections in a closed state. Measured in connections per second from the client.

tcp_established_connections

int64

The number of TCP connections in an established state. Measured in connections per second from the client.

tcp_refusals

int64

The number of TCP connections that were refused by the server. Typically this indicates an attempt to connect to an IP/port that is not receiving connections, or a firewall/security misconfiguration.

tcp_resets

int64

The number of TCP connections that were reset by the server.

tcp_retransmits

int64

TCP Retransmits represent detected failures that are retransmitted to ensure delivery. Measured in count of retransmits from the client.

tcp_timeouts

int64

The number of TCP connections that timed out from the perspective of the operating system. This can indicate general connectivity and latency issues.

id

string

The SingleAggregatedConnectionResponseData id.

type

enum

Aggregated connection resource type. Allowed enum values: aggregated_connection. default: aggregated_connection Allowed enum values: aggregated_connection

default: aggregated_connection

{
  "data": [
    {
      "attributes": {
        "bytes_sent_by_client": "integer",
        "bytes_sent_by_server": "integer",
        "group_bys": {
          "<any-key>": []
        },
        "packets_sent_by_client": "integer",
        "packets_sent_by_server": "integer",
        "rtt_micro_seconds": "integer",
        "tcp_closed_connections": "integer",
        "tcp_established_connections": "integer",
        "tcp_refusals": "integer",
        "tcp_resets": "integer",
        "tcp_retransmits": "integer",
        "tcp_timeouts": "integer"
      },
      "id": "string",
      "type": "string"
    }
  ]
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/network/connections/aggregate" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"