Get Usage Summary

curl --request GET \
  --url https://{tenantDomain}.conductor.one/api/v1/tb-control-plane/usage-summary \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/tb-control-plane/usage-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/tb-control-plane/usage-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/tb-control-plane/usage-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/tb-control-plane/usage-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/tb-control-plane/usage-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

{
  "modelBreakdown": [
    {
      "inputTokens": "<string>",
      "logicalModel": "<string>",
      "modelTarget": "<string>",
      "outputTokens": "<string>",
      "requestCount": "<string>"
    }
  ],
  "series": [
    {
      "bucketStart": "2023-11-07T05:31:56Z",
      "inputTokens": "<string>",
      "outputTokens": "<string>"
    }
  ],
  "totalCacheReadTokens": "<string>",
  "totalCacheWriteTokens": "<string>",
  "totalInputTokens": "<string>",
  "totalOutputTokens": "<string>",
  "totalRequests": "<string>"
}

GET

api

tb-control-plane

usage-summary

Get Usage Summary

curl --request GET \
  --url https://{tenantDomain}.conductor.one/api/v1/tb-control-plane/usage-summary \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/tb-control-plane/usage-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/tb-control-plane/usage-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/tb-control-plane/usage-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/tb-control-plane/usage-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/tb-control-plane/usage-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

{
  "modelBreakdown": [
    {
      "inputTokens": "<string>",
      "logicalModel": "<string>",
      "modelTarget": "<string>",
      "outputTokens": "<string>",
      "requestCount": "<string>"
    }
  ],
  "series": [
    {
      "bucketStart": "2023-11-07T05:31:56Z",
      "inputTokens": "<string>",
      "outputTokens": "<string>"
    }
  ],
  "totalCacheReadTokens": "<string>",
  "totalCacheWriteTokens": "<string>",
  "totalInputTokens": "<string>",
  "totalOutputTokens": "<string>",
  "totalRequests": "<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.

Query Parameters

bucket

enum<string>

Defaults to TB_TIME_BUCKET_HOUR when unset.

Available options:

TB_TIME_BUCKET_UNSPECIFIED,

TB_TIME_BUCKET_HOUR,

TB_TIME_BUCKET_DAY

since

string<int64>

The since field.

until

string<int64>

The until field.

Response

200 - application/json

Successful response

The TBControlPlaneServiceGetUsageSummaryResponse message.

modelBreakdown

Tb Usage Model Breakdown · object[] | null

The modelBreakdown field.

Show child attributes

series

Tb Usage Summary Bucket · object[] | null

The series field.

Show child attributes

totalCacheReadTokens

string<uint64>

The totalCacheReadTokens field.

totalCacheWriteTokens

string<uint64>

The totalCacheWriteTokens field.

totalInputTokens

string<uint64>

The totalInputTokens field.

totalOutputTokens

string<uint64>

The totalOutputTokens field.

totalRequests

string<uint64>

The totalRequests field.

Welcome

Endpoints

Get Usage Summary

Authorizations

Query Parameters

Response