Get aggregated metrics grouped by span name

curl --request POST \
  --url https://api.egp.scale.com/v5/spans/metrics/by-span \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "parents_only": true,
  "span_ids": [
    "<string>"
  ],
  "trace_ids": [
    "<string>"
  ],
  "excluded_span_ids": [
    "<string>"
  ],
  "excluded_trace_ids": [
    "<string>"
  ],
  "group_id": "<string>",
  "names": [
    "<string>"
  ],
  "statuses": [],
  "types": [],
  "search_texts": [
    "<string>"
  ],
  "extra_metadata": {},
  "application_variant_ids": [
    "<string>"
  ],
  "assessment_types": [
    "<string>"
  ],
  "acp_types": [
    "<string>"
  ],
  "agentex_agent_names": [
    "<string>"
  ],
  "agentex_agent_ids": [
    "<string>"
  ],
  "min_duration_ms": 123,
  "max_duration_ms": 123,
  "limit": 100,
  "offset": 0,
  "sort_by": "total_ms"
}
'

import requests

url = "https://api.egp.scale.com/v5/spans/metrics/by-span"

payload = {
    "parents_only": True,
    "span_ids": ["<string>"],
    "trace_ids": ["<string>"],
    "excluded_span_ids": ["<string>"],
    "excluded_trace_ids": ["<string>"],
    "group_id": "<string>",
    "names": ["<string>"],
    "statuses": [],
    "types": [],
    "search_texts": ["<string>"],
    "extra_metadata": {},
    "application_variant_ids": ["<string>"],
    "assessment_types": ["<string>"],
    "acp_types": ["<string>"],
    "agentex_agent_names": ["<string>"],
    "agentex_agent_ids": ["<string>"],
    "min_duration_ms": 123,
    "max_duration_ms": 123,
    "limit": 100,
    "offset": 0,
    "sort_by": "total_ms"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    parents_only: true,
    span_ids: ['<string>'],
    trace_ids: ['<string>'],
    excluded_span_ids: ['<string>'],
    excluded_trace_ids: ['<string>'],
    group_id: '<string>',
    names: ['<string>'],
    statuses: [],
    types: [],
    search_texts: ['<string>'],
    extra_metadata: {},
    application_variant_ids: ['<string>'],
    assessment_types: ['<string>'],
    acp_types: ['<string>'],
    agentex_agent_names: ['<string>'],
    agentex_agent_ids: ['<string>'],
    min_duration_ms: 123,
    max_duration_ms: 123,
    limit: 100,
    offset: 0,
    sort_by: 'total_ms'
  })
};

fetch('https://api.egp.scale.com/v5/spans/metrics/by-span', 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.egp.scale.com/v5/spans/metrics/by-span",
  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([
    'parents_only' => true,
    'span_ids' => [
        '<string>'
    ],
    'trace_ids' => [
        '<string>'
    ],
    'excluded_span_ids' => [
        '<string>'
    ],
    'excluded_trace_ids' => [
        '<string>'
    ],
    'group_id' => '<string>',
    'names' => [
        '<string>'
    ],
    'statuses' => [
        
    ],
    'types' => [
        
    ],
    'search_texts' => [
        '<string>'
    ],
    'extra_metadata' => [
        
    ],
    'application_variant_ids' => [
        '<string>'
    ],
    'assessment_types' => [
        '<string>'
    ],
    'acp_types' => [
        '<string>'
    ],
    'agentex_agent_names' => [
        '<string>'
    ],
    'agentex_agent_ids' => [
        '<string>'
    ],
    'min_duration_ms' => 123,
    'max_duration_ms' => 123,
    'limit' => 100,
    'offset' => 0,
    'sort_by' => 'total_ms'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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.egp.scale.com/v5/spans/metrics/by-span"

	payload := strings.NewReader("{\n  \"parents_only\": true,\n  \"span_ids\": [\n    \"<string>\"\n  ],\n  \"trace_ids\": [\n    \"<string>\"\n  ],\n  \"excluded_span_ids\": [\n    \"<string>\"\n  ],\n  \"excluded_trace_ids\": [\n    \"<string>\"\n  ],\n  \"group_id\": \"<string>\",\n  \"names\": [\n    \"<string>\"\n  ],\n  \"statuses\": [],\n  \"types\": [],\n  \"search_texts\": [\n    \"<string>\"\n  ],\n  \"extra_metadata\": {},\n  \"application_variant_ids\": [\n    \"<string>\"\n  ],\n  \"assessment_types\": [\n    \"<string>\"\n  ],\n  \"acp_types\": [\n    \"<string>\"\n  ],\n  \"agentex_agent_names\": [\n    \"<string>\"\n  ],\n  \"agentex_agent_ids\": [\n    \"<string>\"\n  ],\n  \"min_duration_ms\": 123,\n  \"max_duration_ms\": 123,\n  \"limit\": 100,\n  \"offset\": 0,\n  \"sort_by\": \"total_ms\"\n}")

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

	req.Header.Add("x-api-key", "<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.egp.scale.com/v5/spans/metrics/by-span")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"parents_only\": true,\n  \"span_ids\": [\n    \"<string>\"\n  ],\n  \"trace_ids\": [\n    \"<string>\"\n  ],\n  \"excluded_span_ids\": [\n    \"<string>\"\n  ],\n  \"excluded_trace_ids\": [\n    \"<string>\"\n  ],\n  \"group_id\": \"<string>\",\n  \"names\": [\n    \"<string>\"\n  ],\n  \"statuses\": [],\n  \"types\": [],\n  \"search_texts\": [\n    \"<string>\"\n  ],\n  \"extra_metadata\": {},\n  \"application_variant_ids\": [\n    \"<string>\"\n  ],\n  \"assessment_types\": [\n    \"<string>\"\n  ],\n  \"acp_types\": [\n    \"<string>\"\n  ],\n  \"agentex_agent_names\": [\n    \"<string>\"\n  ],\n  \"agentex_agent_ids\": [\n    \"<string>\"\n  ],\n  \"min_duration_ms\": 123,\n  \"max_duration_ms\": 123,\n  \"limit\": 100,\n  \"offset\": 0,\n  \"sort_by\": \"total_ms\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.egp.scale.com/v5/spans/metrics/by-span")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"parents_only\": true,\n  \"span_ids\": [\n    \"<string>\"\n  ],\n  \"trace_ids\": [\n    \"<string>\"\n  ],\n  \"excluded_span_ids\": [\n    \"<string>\"\n  ],\n  \"excluded_trace_ids\": [\n    \"<string>\"\n  ],\n  \"group_id\": \"<string>\",\n  \"names\": [\n    \"<string>\"\n  ],\n  \"statuses\": [],\n  \"types\": [],\n  \"search_texts\": [\n    \"<string>\"\n  ],\n  \"extra_metadata\": {},\n  \"application_variant_ids\": [\n    \"<string>\"\n  ],\n  \"assessment_types\": [\n    \"<string>\"\n  ],\n  \"acp_types\": [\n    \"<string>\"\n  ],\n  \"agentex_agent_names\": [\n    \"<string>\"\n  ],\n  \"agentex_agent_ids\": [\n    \"<string>\"\n  ],\n  \"min_duration_ms\": 123,\n  \"max_duration_ms\": 123,\n  \"limit\": 100,\n  \"offset\": 0,\n  \"sort_by\": \"total_ms\"\n}"

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

{
  "items": [
    {
      "span_name": "<string>",
      "count": 123,
      "min_ms": 123,
      "avg_ms": 123,
      "p50_ms": 123,
      "p90_ms": 123,
      "p95_ms": 123,
      "p99_ms": 123,
      "max_ms": 123,
      "total_ms": 123,
      "total_time_pct": 123,
      "avg_per_trace": 123
    }
  ],
  "totals": {
    "total_traces": 123,
    "total_spans": 123
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

spans

metrics

by-span

Get aggregated metrics grouped by span name

curl --request POST \
  --url https://api.egp.scale.com/v5/spans/metrics/by-span \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "parents_only": true,
  "span_ids": [
    "<string>"
  ],
  "trace_ids": [
    "<string>"
  ],
  "excluded_span_ids": [
    "<string>"
  ],
  "excluded_trace_ids": [
    "<string>"
  ],
  "group_id": "<string>",
  "names": [
    "<string>"
  ],
  "statuses": [],
  "types": [],
  "search_texts": [
    "<string>"
  ],
  "extra_metadata": {},
  "application_variant_ids": [
    "<string>"
  ],
  "assessment_types": [
    "<string>"
  ],
  "acp_types": [
    "<string>"
  ],
  "agentex_agent_names": [
    "<string>"
  ],
  "agentex_agent_ids": [
    "<string>"
  ],
  "min_duration_ms": 123,
  "max_duration_ms": 123,
  "limit": 100,
  "offset": 0,
  "sort_by": "total_ms"
}
'

import requests

url = "https://api.egp.scale.com/v5/spans/metrics/by-span"

payload = {
    "parents_only": True,
    "span_ids": ["<string>"],
    "trace_ids": ["<string>"],
    "excluded_span_ids": ["<string>"],
    "excluded_trace_ids": ["<string>"],
    "group_id": "<string>",
    "names": ["<string>"],
    "statuses": [],
    "types": [],
    "search_texts": ["<string>"],
    "extra_metadata": {},
    "application_variant_ids": ["<string>"],
    "assessment_types": ["<string>"],
    "acp_types": ["<string>"],
    "agentex_agent_names": ["<string>"],
    "agentex_agent_ids": ["<string>"],
    "min_duration_ms": 123,
    "max_duration_ms": 123,
    "limit": 100,
    "offset": 0,
    "sort_by": "total_ms"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    parents_only: true,
    span_ids: ['<string>'],
    trace_ids: ['<string>'],
    excluded_span_ids: ['<string>'],
    excluded_trace_ids: ['<string>'],
    group_id: '<string>',
    names: ['<string>'],
    statuses: [],
    types: [],
    search_texts: ['<string>'],
    extra_metadata: {},
    application_variant_ids: ['<string>'],
    assessment_types: ['<string>'],
    acp_types: ['<string>'],
    agentex_agent_names: ['<string>'],
    agentex_agent_ids: ['<string>'],
    min_duration_ms: 123,
    max_duration_ms: 123,
    limit: 100,
    offset: 0,
    sort_by: 'total_ms'
  })
};

fetch('https://api.egp.scale.com/v5/spans/metrics/by-span', 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.egp.scale.com/v5/spans/metrics/by-span",
  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([
    'parents_only' => true,
    'span_ids' => [
        '<string>'
    ],
    'trace_ids' => [
        '<string>'
    ],
    'excluded_span_ids' => [
        '<string>'
    ],
    'excluded_trace_ids' => [
        '<string>'
    ],
    'group_id' => '<string>',
    'names' => [
        '<string>'
    ],
    'statuses' => [
        
    ],
    'types' => [
        
    ],
    'search_texts' => [
        '<string>'
    ],
    'extra_metadata' => [
        
    ],
    'application_variant_ids' => [
        '<string>'
    ],
    'assessment_types' => [
        '<string>'
    ],
    'acp_types' => [
        '<string>'
    ],
    'agentex_agent_names' => [
        '<string>'
    ],
    'agentex_agent_ids' => [
        '<string>'
    ],
    'min_duration_ms' => 123,
    'max_duration_ms' => 123,
    'limit' => 100,
    'offset' => 0,
    'sort_by' => 'total_ms'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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.egp.scale.com/v5/spans/metrics/by-span"

	payload := strings.NewReader("{\n  \"parents_only\": true,\n  \"span_ids\": [\n    \"<string>\"\n  ],\n  \"trace_ids\": [\n    \"<string>\"\n  ],\n  \"excluded_span_ids\": [\n    \"<string>\"\n  ],\n  \"excluded_trace_ids\": [\n    \"<string>\"\n  ],\n  \"group_id\": \"<string>\",\n  \"names\": [\n    \"<string>\"\n  ],\n  \"statuses\": [],\n  \"types\": [],\n  \"search_texts\": [\n    \"<string>\"\n  ],\n  \"extra_metadata\": {},\n  \"application_variant_ids\": [\n    \"<string>\"\n  ],\n  \"assessment_types\": [\n    \"<string>\"\n  ],\n  \"acp_types\": [\n    \"<string>\"\n  ],\n  \"agentex_agent_names\": [\n    \"<string>\"\n  ],\n  \"agentex_agent_ids\": [\n    \"<string>\"\n  ],\n  \"min_duration_ms\": 123,\n  \"max_duration_ms\": 123,\n  \"limit\": 100,\n  \"offset\": 0,\n  \"sort_by\": \"total_ms\"\n}")

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

	req.Header.Add("x-api-key", "<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.egp.scale.com/v5/spans/metrics/by-span")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"parents_only\": true,\n  \"span_ids\": [\n    \"<string>\"\n  ],\n  \"trace_ids\": [\n    \"<string>\"\n  ],\n  \"excluded_span_ids\": [\n    \"<string>\"\n  ],\n  \"excluded_trace_ids\": [\n    \"<string>\"\n  ],\n  \"group_id\": \"<string>\",\n  \"names\": [\n    \"<string>\"\n  ],\n  \"statuses\": [],\n  \"types\": [],\n  \"search_texts\": [\n    \"<string>\"\n  ],\n  \"extra_metadata\": {},\n  \"application_variant_ids\": [\n    \"<string>\"\n  ],\n  \"assessment_types\": [\n    \"<string>\"\n  ],\n  \"acp_types\": [\n    \"<string>\"\n  ],\n  \"agentex_agent_names\": [\n    \"<string>\"\n  ],\n  \"agentex_agent_ids\": [\n    \"<string>\"\n  ],\n  \"min_duration_ms\": 123,\n  \"max_duration_ms\": 123,\n  \"limit\": 100,\n  \"offset\": 0,\n  \"sort_by\": \"total_ms\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.egp.scale.com/v5/spans/metrics/by-span")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"parents_only\": true,\n  \"span_ids\": [\n    \"<string>\"\n  ],\n  \"trace_ids\": [\n    \"<string>\"\n  ],\n  \"excluded_span_ids\": [\n    \"<string>\"\n  ],\n  \"excluded_trace_ids\": [\n    \"<string>\"\n  ],\n  \"group_id\": \"<string>\",\n  \"names\": [\n    \"<string>\"\n  ],\n  \"statuses\": [],\n  \"types\": [],\n  \"search_texts\": [\n    \"<string>\"\n  ],\n  \"extra_metadata\": {},\n  \"application_variant_ids\": [\n    \"<string>\"\n  ],\n  \"assessment_types\": [\n    \"<string>\"\n  ],\n  \"acp_types\": [\n    \"<string>\"\n  ],\n  \"agentex_agent_names\": [\n    \"<string>\"\n  ],\n  \"agentex_agent_ids\": [\n    \"<string>\"\n  ],\n  \"min_duration_ms\": 123,\n  \"max_duration_ms\": 123,\n  \"limit\": 100,\n  \"offset\": 0,\n  \"sort_by\": \"total_ms\"\n}"

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

{
  "items": [
    {
      "span_name": "<string>",
      "count": 123,
      "min_ms": 123,
      "avg_ms": 123,
      "p50_ms": 123,
      "p90_ms": 123,
      "p95_ms": 123,
      "p99_ms": 123,
      "max_ms": 123,
      "total_ms": 123,
      "total_time_pct": 123,
      "avg_per_trace": 123
    }
  ],
  "totals": {
    "total_traces": 123,
    "total_spans": 123
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

x-api-key

string

header

required

Headers

x-selected-account-id

string | null

Query Parameters

from_ts

string<date-time> | null

The starting (oldest) timestamp in ISO format.

to_ts

string<date-time> | null

The ending (most recent) timestamp in ISO format.

Body

application/json

parents_only

boolean

Only fetch spans that are the top-level (ie. have no parent_id)

span_ids

string[]

Filter by span IDs

trace_ids

string[]

Filter by trace IDs

excluded_span_ids

string[]

List of span IDs to exclude from results

excluded_trace_ids

string[]

List of trace IDs to exclude from results

group_id

string

Filter by group ID

names

string[]

Filter by trace/span name

statuses

enum<string>[]

Filter on span status

Available options:

SUCCESS,

ERROR,

CANCELED

types

enum<string>[]

Available options:

TEXT_INPUT,

TEXT_OUTPUT,

COMPLETION_INPUT,

COMPLETION,

KB_RETRIEVAL,

KB_INPUT,

RERANKING,

EXTERNAL_ENDPOINT,

PROMPT_ENGINEERING,

DOCUMENT_INPUT,

MAP_REDUCE,

DOCUMENT_SEARCH,

DOCUMENT_PROMPT,

CUSTOM,

CODE_EXECUTION,

DATA_MANIPULATION,

EVALUATION,

FILE_RETRIEVAL,

KB_ADD_CHUNK,

KB_MANAGEMENT,

GUARDRAIL,

OUTPUT_GUARDRAIL,

TRACER,

AGENT_TRACER,

AGENT_WORKFLOW,

STANDALONE

search_texts

string[]

Free text search across span input and output fields. For exact trace ID lookup, use the trace_ids filter.

extra_metadata

Extra Metadata · object

Filter on custom metadata key-value pairs

application_variant_ids

string[]

Filter by application variant IDs

assessment_types

string[]

Filter spans by traces that have assessments of these types

acp_types

string[]

Filter by ACP types

agentex_agent_names

string[]

Filter by Agentex agent names

agentex_agent_ids

string[]

Filter by Agentex agent IDs

min_duration_ms

integer

Minimum span duration in milliseconds (inclusive)

max_duration_ms

integer

Maximum span duration in milliseconds (inclusive)

limit

integer

default:100

Max number of span groups to return

offset

integer

default:0

Offset for pagination of span groups

sort_by

string

default:total_ms

Field to sort by: 'total_ms', 'max_ms', 'avg_ms', or 'count'

Response

Successful Response

items

SpansBySpanMetricsItem · object[]

required

Show child attributes

totals

SpansBySpanMetricsTotals · object

required

Show child attributes

Get bucketed metrics for spans List Span Assessments

⌘I

Inference

Questions

Rubrics

Vector Stores

Files

Models

Agent Configs

Datasets

Dataset Items

Agent Evaluations

Evaluations

Evaluation Groups

Evaluation Charts

Evaluation Dashboards

Evaluation Items

Spans

Span Assessment

Credentials

Agentex Cloud Build

Agentex Cloud Deploy

SGP Cloud Secrets

Get aggregated metrics grouped by span name

Authorizations

Headers

Query Parameters

Body

Response