Network requests

Network detail rows

Serves the merged connections table as client rows: each client endpoint with its summed cost and counters, the tag aggregates of all its request traffic, and its costliest connections nested as servers (server_limit, default 7, negative for all; server_count gives the full number, and the client's sums cover every one). Each connection keeps the reports-side shape -- identity, traffic, health and the monthly cost projection -- with the tag aggregates of its own request traffic, grouped by endpoint pair, port, locality and whether it went through a Service ClusterIP or was NAT translated. Per-zone-pair attribution is on GET /service-map/connections/:id. Totals describe the whole window, computed before the row cap, like the service map, plus the attributed cost of every request row with a connection and how many of those rows carry a shown tag. group_by picks the tag keys aggregated (tag:<key>; empty means every key), group narrows to requests carrying exact tag key/value pairs, and filters (tag:<key>, dst_port, proto) are AND across dimensions and OR within one. Every tag aggregate carries its previous-window sums and cost change. Clients arrive costliest first, capped at limit; the frontend filters, sorts and pages them client-side

POST

api

tenant

network

detail

Network detail rows

curl --request POST \
  --url https://api.costgraph.ai/api/v1/tenant/network/detail \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'X-CostGraph-Tenant-ID: <x-costgraph-tenant-id>' \
  --data '
{
  "filter": {},
  "group": {},
  "group_by": [
    "<string>"
  ],
  "limit": 123,
  "server_limit": 123
}
'

import requests

url = "https://api.costgraph.ai/api/v1/tenant/network/detail"

payload = {
    "filter": {},
    "group": {},
    "group_by": ["<string>"],
    "limit": 123,
    "server_limit": 123
}
headers = {
    "X-CostGraph-Tenant-ID": "<x-costgraph-tenant-id>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-CostGraph-Tenant-ID': '<x-costgraph-tenant-id>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({filter: {}, group: {}, group_by: ['<string>'], limit: 123, server_limit: 123})
};

fetch('https://api.costgraph.ai/api/v1/tenant/network/detail', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.costgraph.ai/api/v1/tenant/network/detail",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'filter' => [
        
    ],
    'group' => [
        
    ],
    'group_by' => [
        '<string>'
    ],
    'limit' => 123,
    'server_limit' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "X-CostGraph-Tenant-ID: <x-costgraph-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.costgraph.ai/api/v1/tenant/network/detail"

	payload := strings.NewReader("{\n  \"filter\": {},\n  \"group\": {},\n  \"group_by\": [\n    \"<string>\"\n  ],\n  \"limit\": 123,\n  \"server_limit\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-CostGraph-Tenant-ID", "<x-costgraph-tenant-id>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.costgraph.ai/api/v1/tenant/network/detail")
  .header("X-CostGraph-Tenant-ID", "<x-costgraph-tenant-id>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filter\": {},\n  \"group\": {},\n  \"group_by\": [\n    \"<string>\"\n  ],\n  \"limit\": 123,\n  \"server_limit\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.costgraph.ai/api/v1/tenant/network/detail")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-CostGraph-Tenant-ID"] = '<x-costgraph-tenant-id>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filter\": {},\n  \"group\": {},\n  \"group_by\": [\n    \"<string>\"\n  ],\n  \"limit\": 123,\n  \"server_limit\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "message": "some message",
  "status": "success",
  "data": {
    "range": {
      "end": "<string>",
      "start": "<string>"
    },
    "rows": [
      {
        "client": "<string>",
        "client_endpoint_id": "<string>",
        "cost_monthly": 123,
        "counters": {
          "bytes_client_to_server": 123,
          "bytes_server_to_client": 123,
          "connections_active_max": 123,
          "connections_closed": 123,
          "connections_failed": 123,
          "connections_opened": 123,
          "connections_refused": 123,
          "connections_reset": 123,
          "observed_from": "<string>",
          "observed_seconds": 123,
          "packets_client_to_server": 123,
          "packets_server_to_client": 123
        },
        "server_count": 123,
        "servers": [
          {
            "client": "<string>",
            "client_endpoint_id": "<string>",
            "cost_monthly": 123,
            "counters": {
              "bytes_client_to_server": 123,
              "bytes_server_to_client": 123,
              "connections_active_max": 123,
              "connections_closed": 123,
              "connections_failed": 123,
              "connections_opened": 123,
              "connections_refused": 123,
              "connections_reset": 123,
              "observed_from": "<string>",
              "observed_seconds": 123,
              "packets_client_to_server": 123,
              "packets_server_to_client": 123
            },
            "id": "<string>",
            "last_seen_at": "<string>",
            "locality": "<string>",
            "nat_translated": true,
            "port": 123,
            "server": "<string>",
            "server_endpoint_id": "<string>",
            "server_kind": "<string>",
            "service_vip_observed": true,
            "tags": [
              {
                "changePct": 123,
                "key": "<string>",
                "previous": {
                  "attributed_cost_monthly": 123,
                  "req_bytes": 123,
                  "resp_bytes": 123
                },
                "totals": {
                  "attributed_cost_monthly": 123,
                  "req_bytes": 123,
                  "resp_bytes": 123
                },
                "value": "<string>"
              }
            ]
          }
        ],
        "tags": [
          {
            "changePct": 123,
            "key": "<string>",
            "previous": {
              "attributed_cost_monthly": 123,
              "req_bytes": 123,
              "resp_bytes": 123
            },
            "totals": {
              "attributed_cost_monthly": 123,
              "req_bytes": 123,
              "resp_bytes": 123
            },
            "value": "<string>"
          }
        ]
      }
    ],
    "totals": {
      "attributed_cost_monthly": 123,
      "bytes_by_locality": {},
      "bytes_client_to_server": 123,
      "bytes_server_to_client": 123,
      "cost_attributed_connections": 123,
      "cost_by_locality": {},
      "cost_by_mechanism": {},
      "request_cost_monthly": 123,
      "tagged_requests": 123,
      "total_connections": 123,
      "total_services": 123,
      "unhealthy_connections": 123
    }
  }
}

{
  "message": "some message",
  "status": "error"
}

{
  "message": "some message",
  "status": "error"
}

{
  "message": "some message",
  "status": "error"
}

{
  "message": "some message",
  "status": "error"
}

Authorizations

Authorization

string

header

required

Enter "Bearer {token}"

Headers

X-CostGraph-Tenant-ID

string

required

Tenant ID

Query Parameters

period

enum<string>

Cost period; defaults to month_to_date

Available options:

month_to_date,

last_7d,

last_30d,

calendar_month,

custom

month

string

Closed calendar month in YYYY-MM format; required when period=calendar_month

start

string

Window start in RFC3339 format; required when period=custom

end

string

Window end in RFC3339 format; required when period=custom

Body

application/json

Tag keys to aggregate (group_by, tag:), exact tag pairs to narrow to (group, bare keys), filters as dimension -> values, sort_by (cost|bytes) for tags, and limit capping the client rows at the costliest N (default 500, max 5000, negative unpaged), and server_limit capping each client's servers (default 7, negative for all). Every field is optional

filter

object

Show child attributes

group

object

Show child attributes

group_by

string[]

limit

integer | null

Caps the client rows at the costliest N; a negative Limit is unpaged.

server_limit

integer | null

Caps each client's servers at its costliest N; a negative ServerLimit returns them all.

sort_by

enum<string>

Available options:

cost,

bytes

Response

message

string

required

Example:

"some message"

status

string

required

Example:

"success"

data

object

Show child attributes

Network detail rows

curl --request POST \
  --url https://api.costgraph.ai/api/v1/tenant/network/detail \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'X-CostGraph-Tenant-ID: <x-costgraph-tenant-id>' \
  --data '
{
  "filter": {},
  "group": {},
  "group_by": [
    "<string>"
  ],
  "limit": 123,
  "server_limit": 123
}
'

import requests

url = "https://api.costgraph.ai/api/v1/tenant/network/detail"

payload = {
    "filter": {},
    "group": {},
    "group_by": ["<string>"],
    "limit": 123,
    "server_limit": 123
}
headers = {
    "X-CostGraph-Tenant-ID": "<x-costgraph-tenant-id>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-CostGraph-Tenant-ID': '<x-costgraph-tenant-id>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({filter: {}, group: {}, group_by: ['<string>'], limit: 123, server_limit: 123})
};

fetch('https://api.costgraph.ai/api/v1/tenant/network/detail', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.costgraph.ai/api/v1/tenant/network/detail",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'filter' => [
        
    ],
    'group' => [
        
    ],
    'group_by' => [
        '<string>'
    ],
    'limit' => 123,
    'server_limit' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "X-CostGraph-Tenant-ID: <x-costgraph-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.costgraph.ai/api/v1/tenant/network/detail"

	payload := strings.NewReader("{\n  \"filter\": {},\n  \"group\": {},\n  \"group_by\": [\n    \"<string>\"\n  ],\n  \"limit\": 123,\n  \"server_limit\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-CostGraph-Tenant-ID", "<x-costgraph-tenant-id>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.costgraph.ai/api/v1/tenant/network/detail")
  .header("X-CostGraph-Tenant-ID", "<x-costgraph-tenant-id>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filter\": {},\n  \"group\": {},\n  \"group_by\": [\n    \"<string>\"\n  ],\n  \"limit\": 123,\n  \"server_limit\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.costgraph.ai/api/v1/tenant/network/detail")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-CostGraph-Tenant-ID"] = '<x-costgraph-tenant-id>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filter\": {},\n  \"group\": {},\n  \"group_by\": [\n    \"<string>\"\n  ],\n  \"limit\": 123,\n  \"server_limit\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "message": "some message",
  "status": "success",
  "data": {
    "range": {
      "end": "<string>",
      "start": "<string>"
    },
    "rows": [
      {
        "client": "<string>",
        "client_endpoint_id": "<string>",
        "cost_monthly": 123,
        "counters": {
          "bytes_client_to_server": 123,
          "bytes_server_to_client": 123,
          "connections_active_max": 123,
          "connections_closed": 123,
          "connections_failed": 123,
          "connections_opened": 123,
          "connections_refused": 123,
          "connections_reset": 123,
          "observed_from": "<string>",
          "observed_seconds": 123,
          "packets_client_to_server": 123,
          "packets_server_to_client": 123
        },
        "server_count": 123,
        "servers": [
          {
            "client": "<string>",
            "client_endpoint_id": "<string>",
            "cost_monthly": 123,
            "counters": {
              "bytes_client_to_server": 123,
              "bytes_server_to_client": 123,
              "connections_active_max": 123,
              "connections_closed": 123,
              "connections_failed": 123,
              "connections_opened": 123,
              "connections_refused": 123,
              "connections_reset": 123,
              "observed_from": "<string>",
              "observed_seconds": 123,
              "packets_client_to_server": 123,
              "packets_server_to_client": 123
            },
            "id": "<string>",
            "last_seen_at": "<string>",
            "locality": "<string>",
            "nat_translated": true,
            "port": 123,
            "server": "<string>",
            "server_endpoint_id": "<string>",
            "server_kind": "<string>",
            "service_vip_observed": true,
            "tags": [
              {
                "changePct": 123,
                "key": "<string>",
                "previous": {
                  "attributed_cost_monthly": 123,
                  "req_bytes": 123,
                  "resp_bytes": 123
                },
                "totals": {
                  "attributed_cost_monthly": 123,
                  "req_bytes": 123,
                  "resp_bytes": 123
                },
                "value": "<string>"
              }
            ]
          }
        ],
        "tags": [
          {
            "changePct": 123,
            "key": "<string>",
            "previous": {
              "attributed_cost_monthly": 123,
              "req_bytes": 123,
              "resp_bytes": 123
            },
            "totals": {
              "attributed_cost_monthly": 123,
              "req_bytes": 123,
              "resp_bytes": 123
            },
            "value": "<string>"
          }
        ]
      }
    ],
    "totals": {
      "attributed_cost_monthly": 123,
      "bytes_by_locality": {},
      "bytes_client_to_server": 123,
      "bytes_server_to_client": 123,
      "cost_attributed_connections": 123,
      "cost_by_locality": {},
      "cost_by_mechanism": {},
      "request_cost_monthly": 123,
      "tagged_requests": 123,
      "total_connections": 123,
      "total_services": 123,
      "unhealthy_connections": 123
    }
  }
}

{
  "message": "some message",
  "status": "error"
}

{
  "message": "some message",
  "status": "error"
}

{
  "message": "some message",
  "status": "error"
}

{
  "message": "some message",
  "status": "error"
}

Getting started

Endpoints

Network detail rows

Authorizations

Headers

Query Parameters

Body

Response