Get AgentOS Metrics

Retrieve AgentOS metrics and analytics data for a specified date range. If no date range is specified, returns all available metrics.

GET /metrics

Get AgentOS Metrics

cURL

curl --request GET \
  --url https://api.example.com/metrics \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/metrics"

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

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

print(response.text)

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

fetch('https://api.example.com/metrics', 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.example.com/metrics",
  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://api.example.com/metrics"

	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))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/metrics")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/metrics")

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

200

{
  "metrics": [
    {
      "id": "7bf39658-a00a-484c-8a28-67fd8a9ddb2a",
      "agent_runs_count": 5,
      "agent_sessions_count": 5,
      "team_runs_count": 0,
      "team_sessions_count": 0,
      "workflow_runs_count": 0,
      "workflow_sessions_count": 0,
      "users_count": 1,
      "token_metrics": {
        "input_tokens": 448,
        "output_tokens": 148,
        "total_tokens": 596,
        "audio_tokens": 0,
        "input_audio_tokens": 0,
        "output_audio_tokens": 0,
        "cached_tokens": 0,
        "cache_write_tokens": 0,
        "reasoning_tokens": 0
      },
      "model_metrics": [
        {
          "model_id": "gpt-4o",
          "model_provider": "OpenAI",
          "count": 5
        }
      ],
      "date": "2025-07-31T00:00:00Z",
      "created_at": "2025-07-31T12:38:52Z",
      "updated_at": "2025-07-31T12:49:01Z"
    }
  ]
}

{
  "detail": "Bad request",
  "error_code": "BAD_REQUEST"
}

{
  "detail": "Unauthenticated access",
  "error_code": "UNAUTHENTICATED"
}

{
  "detail": "Not found",
  "error_code": "NOT_FOUND"
}

{
  "detail": "Validation error",
  "error_code": "VALIDATION_ERROR"
}

{
  "detail": "Internal server error",
  "error_code": "INTERNAL_SERVER_ERROR"
}

Authorizations

Authorization · string · header · required

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

Query Parameters

starting_date · string<date> | null

Starting date for metrics range (YYYY-MM-DD format)

ending_date · string<date> | null

Ending date for metrics range (YYYY-MM-DD format)

db_id · string | null

Database ID to query metrics from

table · string | null

The database table to use

Response

200

application/json

Metrics retrieved successfully

metrics · DayAggregatedMetrics · object[] · required

List of daily aggregated metrics

Show child attributes

updated_at · string<date-time> | null

Timestamp of the most recent metrics update