Get Egress Traffic Summary

curl --request GET \
  --url https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/edges/{id}/egress/traffic-summary \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/edges/{id}/egress/traffic-summary"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/edges/{id}/egress/traffic-summary', 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://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/edges/{id}/egress/traffic-summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/edges/{id}/egress/traffic-summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/edges/{id}/egress/traffic-summary")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "agentKindCounts": [
    {
      "count": "<string>",
      "kind": "<string>"
    }
  ],
  "allowedEvents": "<string>",
  "deniedEvents": "<string>",
  "distinctAgentCount": "<string>",
  "distinctDestinationCount": "<string>",
  "distinctToolCount": "<string>",
  "fallbackAgentCount": "<string>",
  "p95LatencyMs": "<string>",
  "series": [
    {
      "allowedEvents": "<string>",
      "bucketStart": "2023-11-07T05:31:56Z",
      "deniedEvents": "<string>",
      "unspecifiedEvents": "<string>"
    }
  ],
  "totalEvents": "<string>",
  "totalRequestBytes": "<string>",
  "totalResponseBytes": "<string>",
  "unspecifiedEvents": "<string>"
}

GET

api

apps

{app_id}

edges

{id}

egress

traffic-summary

Get Egress Traffic Summary

curl --request GET \
  --url https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/edges/{id}/egress/traffic-summary \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/edges/{id}/egress/traffic-summary"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/edges/{id}/egress/traffic-summary', 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://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/edges/{id}/egress/traffic-summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/edges/{id}/egress/traffic-summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/edges/{id}/egress/traffic-summary")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "agentKindCounts": [
    {
      "count": "<string>",
      "kind": "<string>"
    }
  ],
  "allowedEvents": "<string>",
  "deniedEvents": "<string>",
  "distinctAgentCount": "<string>",
  "distinctDestinationCount": "<string>",
  "distinctToolCount": "<string>",
  "fallbackAgentCount": "<string>",
  "p95LatencyMs": "<string>",
  "series": [
    {
      "allowedEvents": "<string>",
      "bucketStart": "2023-11-07T05:31:56Z",
      "deniedEvents": "<string>",
      "unspecifiedEvents": "<string>"
    }
  ],
  "totalEvents": "<string>",
  "totalRequestBytes": "<string>",
  "totalResponseBytes": "<string>",
  "unspecifiedEvents": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization

string

header

required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Path Parameters

app_id

string

required

The appId field.

string

required

The id field.

Query Parameters

bucket

enum<string>

The bucket field.

Available options:

TB_TIME_BUCKET_UNSPECIFIED,

TB_TIME_BUCKET_HOUR,

TB_TIME_BUCKET_DAY

dimension

enum<string>

The dimension field.

Available options:

TB_USAGE_ATTRIBUTION_DIMENSION_UNSPECIFIED,

TB_USAGE_ATTRIBUTION_DIMENSION_TEAM,

TB_USAGE_ATTRIBUTION_DIMENSION_APPLICATION,

TB_USAGE_ATTRIBUTION_DIMENSION_AGENT,

TB_USAGE_ATTRIBUTION_DIMENSION_COST_CENTER,

TB_USAGE_ATTRIBUTION_DIMENSION_USER,

TB_USAGE_ATTRIBUTION_DIMENSION_PROVIDER,

TB_USAGE_ATTRIBUTION_DIMENSION_MODEL

page_size

integer<int32>

The pageSize field.

page_token

string

The pageToken field.

since

string<int64>

The since field.

until

string<int64>

The until field.

Response

200 - application/json

Successful response

The EdgeServiceGetEgressTrafficSummaryResponse message.

agentKindCounts

Agent Kind Count · object[] | null

Distinct source_principal per source_principal_kind.

Show child attributes

allowedEvents

string<uint64>

The allowedEvents field.

deniedEvents

string<uint64>

The deniedEvents field.

distinctAgentCount

string<uint64>

The distinctAgentCount field.

distinctDestinationCount

string<int64>

uniqExact(dest_host) over the window, excluding empty dest_host.

distinctToolCount

string<uint64>

The distinctToolCount field.

fallbackAgentCount

string<int64>

Distinct source_principal with at least one row whose verdict resolved via the fail-closed default rather than an explicit policy match -- the "policy coverage" KPI: agents Edge saw but has no rule for yet.

p95LatencyMs

string<uint64>

Approximate 95th percentile of counter_latency_ms over the window (ClickHouse quantile(0.95)); 0 when the window has no rows.

series

Tb Traffic Summary Bucket · object[] | null

The series field.

Show child attributes

totalEvents

string<uint64>

The totalEvents field.

totalRequestBytes

string<uint64>

The totalRequestBytes field.

totalResponseBytes

string<uint64>

The totalResponseBytes field.

unspecifiedEvents

string<uint64>

The unspecifiedEvents field.

Welcome

Endpoints

Get Egress Traffic Summary

Authorizations

Path Parameters

Query Parameters

Response