Get Project Metrics | Opik Documentation

POST/v1/private/projects/{id}/metricsGet Project Metrics

Gets specified metrics for a project

Parameters

idstring · uuidpathrequired

Request body

application/json

objectProjectMetricRequest_Public

breakdownobject

Show child attributes

fieldstring

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

metadata_keystring

sub_metricstring

intervalstring

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

interval_endstring · date-time

interval_startstring · date-time

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"

span_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

thread_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

trace_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

Example request

{
  "breakdown": {
    "field": "error_info",
    "metadata_key": "string",
    "sub_metric": "string"
  },
  "interval": "DAILY",
  "interval_end": "2026-06-09T00:00:00Z",
  "interval_start": "2026-06-09T00:00:00Z",
  "metric_type": "COST",
  "span_filters": [
    {
      "field": "string",
      "key": "string",
      "operator": "!=",
      "value": "string"
    }
  ],
  "thread_filters": [
    {
      "field": "string",
      "key": "string",
      "operator": "!=",
      "value": "string"
    }
  ],
  "trace_filters": [
    {
      "field": "string",
      "key": "string",
      "operator": "!=",
      "value": "string"
    }
  ]
}

Responses

objectProjectMetricResponse_Public

intervalstring

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

metric_typestring

project_idstring · uuid

resultsarray of object

Show child attributes

Show array items

dataarray of object

Show child attributes

Show array items

timestring · date-timerequired

valuenumber

namestring

Example response

{
  "interval": "DAILY",
  "metric_type": "COST",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "results": [
    {
      "data": [
        {
          "time": "2026-06-09T00:00:00Z",
          "value": 0
        }
      ],
      "name": "string"
    }
  ]
}

objectErrorMessage_Public

codeinteger · int32

detailsstring

messagestring

Example response

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

objectErrorMessage_Public

codeinteger · int32

detailsstring

messagestring

Example response

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

Examples

idrequiredpath parameter

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

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

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

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/metrics",
    headers={"Content-Type": "application/json"},
    data='{"breakdown":{"field":"error_info","metadata_key":"string","sub_metric":"string"},"interval":"DAILY","interval_end":"2026-06-09T00:00:00Z","interval_start":"2026-06-09T00:00:00Z","metric_type":"COST","span_filters":[{"field":"string","key":"string","operator":"!=","value":"string"}],"thread_filters":[{"field":"string","key":"string","operator":"!=","value":"string"}],"trace_filters":[{"field":"string","key":"string","operator":"!=","value":"string"}]}',
)
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"},"interval":"DAILY","interval_end":"2026-06-09T00:00:00Z","interval_start":"2026-06-09T00:00:00Z","metric_type":"COST","span_filters":[{"field":"string","key":"string","operator":"!=","value":"string"}],"thread_filters":[{"field":"string","key":"string","operator":"!=","value":"string"}],"trace_filters":[{"field":"string","key":"string","operator":"!=","value":"string"}]}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/metrics", 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/projects/00000000-0000-0000-0000-000000000000/metrics");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"breakdown\":{\"field\":\"error_info\",\"metadata_key\":\"string\",\"sub_metric\":\"string\"},\"interval\":\"DAILY\",\"interval_end\":\"2026-06-09T00:00:00Z\",\"interval_start\":\"2026-06-09T00:00:00Z\",\"metric_type\":\"COST\",\"span_filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"thread_filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"trace_filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}]}");
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/projects/00000000-0000-0000-0000-000000000000/metrics"))
    .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\"},\"interval\":\"DAILY\",\"interval_end\":\"2026-06-09T00:00:00Z\",\"interval_start\":\"2026-06-09T00:00:00Z\",\"metric_type\":\"COST\",\"span_filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"thread_filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"trace_filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}]}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/metrics")
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\"},\"interval\":\"DAILY\",\"interval_end\":\"2026-06-09T00:00:00Z\",\"interval_start\":\"2026-06-09T00:00:00Z\",\"metric_type\":\"COST\",\"span_filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"thread_filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"trace_filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}]}"
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/projects/00000000-0000-0000-0000-000000000000/metrics");
request.Content = new StringContent("{\"breakdown\":{\"field\":\"error_info\",\"metadata_key\":\"string\",\"sub_metric\":\"string\"},\"interval\":\"DAILY\",\"interval_end\":\"2026-06-09T00:00:00Z\",\"interval_start\":\"2026-06-09T00:00:00Z\",\"metric_type\":\"COST\",\"span_filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"thread_filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"trace_filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}]}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "interval": "DAILY",
  "metric_type": "COST",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "results": [
    {
      "data": [
        {
          "time": "2026-06-09T00:00:00Z",
          "value": 0
        }
      ],
      "name": "string"
    }
  ]
}

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

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