Get workspace span metric | Opik Documentation

POST/v1/private/workspaces/metrics/spansGet workspace span metric

Gets a span metric time series aggregated across the workspace. When project_ids is empty, all projects in the workspace are included; otherwise only the given projects.

Request body

application/json

objectWorkspaceSpanMetricRequest

breakdownobject

Show child attributes

fieldstring

one of "none", "tags", "metadata", "name", "error_info", "error_type", "model", "provider", "type", "guardrail_name"

metadata_keystring

sub_metricstring

filtersarray of object

Show child attributes

Show array items

fieldstring

keystring

operatorstring

one of "contains", "not_contains", "starts_with", "ends_with", "=", "!=", ">", ">=", "<", "<=", "is_empty", "is_not_empty", "in", "not_in"

valuestring

intervalstring

one of "HOURLY", "DAILY", "WEEKLY", "TOTAL"

interval_endstring · date-time

interval_startstring · date-timerequired

metric_typestring

one of "FEEDBACK_SCORES", "TRACE_COUNT", "TOKEN_USAGE", "DURATION", "COST", "GUARDRAILS_FAILED_COUNT", "THREAD_COUNT", "THREAD_DURATION", "THREAD_FEEDBACK_SCORES", "SPAN_FEEDBACK_SCORES", "SPAN_COUNT", "SPAN_DURATION", "SPAN_TOKEN_USAGE", "TRACE_AVERAGE_DURATION", "TRACE_ERROR_RATE", "SPAN_AVERAGE_DURATION", "SPAN_COST", "SPAN_ERROR_RATE", "THREAD_AVERAGE_DURATION", "THREAD_COST"

project_idsarray of string · uuid

uniqueItems true

Show child attributes

uniqueItems true

start_before_endboolean

Example request

{
  "breakdown": {
    "field": "error_info",
    "metadata_key": "string",
    "sub_metric": "string"
  },
  "filters": [
    {
      "field": "string",
      "key": "string",
      "operator": "!=",
      "value": "string"
    }
  ],
  "interval": "DAILY",
  "interval_end": "2026-06-09T00:00:00Z",
  "interval_start": "2026-06-09T00:00:00Z",
  "metric_type": "COST",
  "project_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "start_before_end": true
}

Responses

objectWorkspaceMetricResponse

resultsarray of object

Show child attributes

Show array items

currentnumber · double

namestring

previousnumber · double

Example response

{
  "results": [
    {
      "current": 0,
      "name": "string",
      "previous": 0
    }
  ]
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

Examples

curl -X POST 'http://localhost:5173/api/v1/private/workspaces/metrics/spans' \
  -H 'Content-Type: application/json' \
  -d '{"breakdown":{"field":"error_info","metadata_key":"string","sub_metric":"string"},"filters":[{"field":"string","key":"string","operator":"!=","value":"string"}],"interval":"DAILY","interval_end":"2026-06-09T00:00:00Z","interval_start":"2026-06-09T00:00:00Z","metric_type":"COST","project_ids":["00000000-0000-0000-0000-000000000000"],"start_before_end":true}'

const response = await fetch('http://localhost:5173/api/v1/private/workspaces/metrics/spans', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"breakdown":{"field":"error_info","metadata_key":"string","sub_metric":"string"},"filters":[{"field":"string","key":"string","operator":"!=","value":"string"}],"interval":"DAILY","interval_end":"2026-06-09T00:00:00Z","interval_start":"2026-06-09T00:00:00Z","metric_type":"COST","project_ids":["00000000-0000-0000-0000-000000000000"],"start_before_end":true}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/workspaces/metrics/spans', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"breakdown\":{\"field\":\"error_info\",\"metadata_key\":\"string\",\"sub_metric\":\"string\"},\"filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"interval\":\"DAILY\",\"interval_end\":\"2026-06-09T00:00:00Z\",\"interval_start\":\"2026-06-09T00:00:00Z\",\"metric_type\":\"COST\",\"project_ids\":[\"00000000-0000-0000-0000-000000000000\"],\"start_before_end\":true}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/workspaces/metrics/spans",
    headers={"Content-Type": "application/json"},
    data='{"breakdown":{"field":"error_info","metadata_key":"string","sub_metric":"string"},"filters":[{"field":"string","key":"string","operator":"!=","value":"string"}],"interval":"DAILY","interval_end":"2026-06-09T00:00:00Z","interval_start":"2026-06-09T00:00:00Z","metric_type":"COST","project_ids":["00000000-0000-0000-0000-000000000000"],"start_before_end":true}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"breakdown":{"field":"error_info","metadata_key":"string","sub_metric":"string"},"filters":[{"field":"string","key":"string","operator":"!=","value":"string"}],"interval":"DAILY","interval_end":"2026-06-09T00:00:00Z","interval_start":"2026-06-09T00:00:00Z","metric_type":"COST","project_ids":["00000000-0000-0000-0000-000000000000"],"start_before_end":true}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/workspaces/metrics/spans", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/workspaces/metrics/spans");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"breakdown\":{\"field\":\"error_info\",\"metadata_key\":\"string\",\"sub_metric\":\"string\"},\"filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"interval\":\"DAILY\",\"interval_end\":\"2026-06-09T00:00:00Z\",\"interval_start\":\"2026-06-09T00:00:00Z\",\"metric_type\":\"COST\",\"project_ids\":[\"00000000-0000-0000-0000-000000000000\"],\"start_before_end\":true}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/workspaces/metrics/spans"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"breakdown\":{\"field\":\"error_info\",\"metadata_key\":\"string\",\"sub_metric\":\"string\"},\"filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"interval\":\"DAILY\",\"interval_end\":\"2026-06-09T00:00:00Z\",\"interval_start\":\"2026-06-09T00:00:00Z\",\"metric_type\":\"COST\",\"project_ids\":[\"00000000-0000-0000-0000-000000000000\"],\"start_before_end\":true}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/workspaces/metrics/spans")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"breakdown\":{\"field\":\"error_info\",\"metadata_key\":\"string\",\"sub_metric\":\"string\"},\"filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"interval\":\"DAILY\",\"interval_end\":\"2026-06-09T00:00:00Z\",\"interval_start\":\"2026-06-09T00:00:00Z\",\"metric_type\":\"COST\",\"project_ids\":[\"00000000-0000-0000-0000-000000000000\"],\"start_before_end\":true}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:5173/api/v1/private/workspaces/metrics/spans");
request.Content = new StringContent("{\"breakdown\":{\"field\":\"error_info\",\"metadata_key\":\"string\",\"sub_metric\":\"string\"},\"filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"interval\":\"DAILY\",\"interval_end\":\"2026-06-09T00:00:00Z\",\"interval_start\":\"2026-06-09T00:00:00Z\",\"metric_type\":\"COST\",\"project_ids\":[\"00000000-0000-0000-0000-000000000000\"],\"start_before_end\":true}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "results": [
    {
      "current": 0,
      "name": "string",
      "previous": 0
    }
  ]
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}