Network requests

Network flow tree

Groups the filtered network flows into a tree by group_by, a list of one or more dimensions applied outermost first: client, client_kind, server, server_kind, server_port, locality and proto. Every node carries its cost, bytes (total and per direction), connections opened, unhealthy connections, share of the filtered bytes and cost, the direction the cost is charged for, and connection_ids (up to 100, connection_ids_truncated when more exist) for charting through GET /service-map/connections//series. sort_by (cost|bytes, default cost) orders the groups at every level. group_limit (default 20, max 100, negative for all) caps the children under each parent and remainder sums what was cut; group_offset pages the top level only. children_total and nodes_total give the full group counts. A node’s cost is null when none of its flows is priced. Every node and the totals also carry previous_bytes_total, previous_cost_monthly (the previous period’s traffic priced at each connection’s current rate), bytes_change_pct and cost_change_pct, which are null when there is no previous value. Totals describe all filtered flows, so they equal the network detail totals for the same filters. Filters accept locality, kind (the server endpoint kind) and dst_port, AND across dimensions and OR within one.

POST

api

tenant

network

tree

Network flow tree

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

import requests

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

payload = {
    "filter": {},
    "group_by": ["<string>"],
    "group_limit": 123,
    "group_offset": 1,
    "scope": ["<string>"]
}
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_by: ['<string>'],
    group_limit: 123,
    group_offset: 1,
    scope: ['<string>']
  })
};

fetch('https://api.costgraph.ai/api/v1/tenant/network/tree', 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/tree",
  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_by' => [
        '<string>'
    ],
    'group_limit' => 123,
    'group_offset' => 1,
    'scope' => [
        '<string>'
    ]
  ]),
  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/tree"

	payload := strings.NewReader("{\n  \"filter\": {},\n  \"group_by\": [\n    \"<string>\"\n  ],\n  \"group_limit\": 123,\n  \"group_offset\": 1,\n  \"scope\": [\n    \"<string>\"\n  ]\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/tree")
  .header("X-CostGraph-Tenant-ID", "<x-costgraph-tenant-id>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filter\": {},\n  \"group_by\": [\n    \"<string>\"\n  ],\n  \"group_limit\": 123,\n  \"group_offset\": 1,\n  \"scope\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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_by\": [\n    \"<string>\"\n  ],\n  \"group_limit\": 123,\n  \"group_offset\": 1,\n  \"scope\": [\n    \"<string>\"\n  ]\n}"

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

{
  "message": "some message",
  "status": "success",
  "data": {
    "dimensions": [
      "<string>"
    ],
    "nodes": [
      {
        "bytes_change_pct": 123,
        "bytes_client_to_server": 123,
        "bytes_server_to_client": 123,
        "bytes_total": 123,
        "charged_direction": "<string>",
        "children": "<array>",
        "children_total": 123,
        "connection_ids": [
          "<string>"
        ],
        "connection_ids_truncated": true,
        "connections_opened": 123,
        "cost_change_pct": 123,
        "cost_monthly": 123,
        "dimension": "<string>",
        "key": "<string>",
        "kind": "<string>",
        "label": "<string>",
        "previous_bytes_total": 123,
        "previous_cost_monthly": 123,
        "remainder": {
          "bytes_total": 123,
          "cost_monthly": 123,
          "count": 123,
          "unhealthy_connections": 123
        },
        "share_of_bytes": 123,
        "share_of_cost": 123,
        "unhealthy_connections": 123
      }
    ],
    "nodes_total": 123,
    "range": {
      "end": "<string>",
      "start": "<string>"
    },
    "remainder": {
      "bytes_total": 123,
      "cost_monthly": 123,
      "count": 123,
      "unhealthy_connections": 123
    },
    "scope_node": {
      "bytes_change_pct": 123,
      "bytes_client_to_server": 123,
      "bytes_server_to_client": 123,
      "bytes_total": 123,
      "charged_direction": "<string>",
      "children": "<array>",
      "children_total": 123,
      "connection_ids": [
        "<string>"
      ],
      "connection_ids_truncated": true,
      "connections_opened": 123,
      "cost_change_pct": 123,
      "cost_monthly": 123,
      "dimension": "<string>",
      "key": "<string>",
      "kind": "<string>",
      "label": "<string>",
      "previous_bytes_total": 123,
      "previous_cost_monthly": 123,
      "remainder": {
        "bytes_total": 123,
        "cost_monthly": 123,
        "count": 123,
        "unhealthy_connections": 123
      },
      "share_of_bytes": 123,
      "share_of_cost": 123,
      "unhealthy_connections": 123
    },
    "totals": {
      "bytes_change_pct": 123,
      "bytes_total": 123,
      "connections": 123,
      "connections_opened": 123,
      "cost_change_pct": 123,
      "cost_monthly": 123,
      "previous_bytes_total": 123,
      "previous_cost_monthly": 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

Dimensions to nest by (group_by), filters as dimension -> values, sort_by (cost|bytes), group_limit and group_offset

filter

object

Show child attributes

group_by

string[]

group_limit

integer | null

group_offset

integer

Required range: x >= 0

scope

string[]

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 flow tree

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

import requests

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

payload = {
    "filter": {},
    "group_by": ["<string>"],
    "group_limit": 123,
    "group_offset": 1,
    "scope": ["<string>"]
}
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_by: ['<string>'],
    group_limit: 123,
    group_offset: 1,
    scope: ['<string>']
  })
};

fetch('https://api.costgraph.ai/api/v1/tenant/network/tree', 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/tree",
  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_by' => [
        '<string>'
    ],
    'group_limit' => 123,
    'group_offset' => 1,
    'scope' => [
        '<string>'
    ]
  ]),
  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/tree"

	payload := strings.NewReader("{\n  \"filter\": {},\n  \"group_by\": [\n    \"<string>\"\n  ],\n  \"group_limit\": 123,\n  \"group_offset\": 1,\n  \"scope\": [\n    \"<string>\"\n  ]\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/tree")
  .header("X-CostGraph-Tenant-ID", "<x-costgraph-tenant-id>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filter\": {},\n  \"group_by\": [\n    \"<string>\"\n  ],\n  \"group_limit\": 123,\n  \"group_offset\": 1,\n  \"scope\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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_by\": [\n    \"<string>\"\n  ],\n  \"group_limit\": 123,\n  \"group_offset\": 1,\n  \"scope\": [\n    \"<string>\"\n  ]\n}"

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

{
  "message": "some message",
  "status": "success",
  "data": {
    "dimensions": [
      "<string>"
    ],
    "nodes": [
      {
        "bytes_change_pct": 123,
        "bytes_client_to_server": 123,
        "bytes_server_to_client": 123,
        "bytes_total": 123,
        "charged_direction": "<string>",
        "children": "<array>",
        "children_total": 123,
        "connection_ids": [
          "<string>"
        ],
        "connection_ids_truncated": true,
        "connections_opened": 123,
        "cost_change_pct": 123,
        "cost_monthly": 123,
        "dimension": "<string>",
        "key": "<string>",
        "kind": "<string>",
        "label": "<string>",
        "previous_bytes_total": 123,
        "previous_cost_monthly": 123,
        "remainder": {
          "bytes_total": 123,
          "cost_monthly": 123,
          "count": 123,
          "unhealthy_connections": 123
        },
        "share_of_bytes": 123,
        "share_of_cost": 123,
        "unhealthy_connections": 123
      }
    ],
    "nodes_total": 123,
    "range": {
      "end": "<string>",
      "start": "<string>"
    },
    "remainder": {
      "bytes_total": 123,
      "cost_monthly": 123,
      "count": 123,
      "unhealthy_connections": 123
    },
    "scope_node": {
      "bytes_change_pct": 123,
      "bytes_client_to_server": 123,
      "bytes_server_to_client": 123,
      "bytes_total": 123,
      "charged_direction": "<string>",
      "children": "<array>",
      "children_total": 123,
      "connection_ids": [
        "<string>"
      ],
      "connection_ids_truncated": true,
      "connections_opened": 123,
      "cost_change_pct": 123,
      "cost_monthly": 123,
      "dimension": "<string>",
      "key": "<string>",
      "kind": "<string>",
      "label": "<string>",
      "previous_bytes_total": 123,
      "previous_cost_monthly": 123,
      "remainder": {
        "bytes_total": 123,
        "cost_monthly": 123,
        "count": 123,
        "unhealthy_connections": 123
      },
      "share_of_bytes": 123,
      "share_of_cost": 123,
      "unhealthy_connections": 123
    },
    "totals": {
      "bytes_change_pct": 123,
      "bytes_total": 123,
      "connections": 123,
      "connections_opened": 123,
      "cost_change_pct": 123,
      "cost_monthly": 123,
      "previous_bytes_total": 123,
      "previous_cost_monthly": 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 flow tree

Authorizations

Headers

Query Parameters

Body

Response