Get Project KPI Cards | Opik Documentation

POST/v1/private/projects/{id}/kpi-cardsGet Project KPI Cards

Gets KPI card metrics for a project

Parameters

idstring · uuidpathrequired

Request body

application/json

objectKpiCardRequest

entity_typestringrequired

one of "traces", "spans", "threads"

filtersstring

interval_endstring · date-time

interval_startstring · date-timerequired

Example request

{
  "entity_type": "spans",
  "filters": "string",
  "interval_end": "2026-06-09T00:00:00Z",
  "interval_start": "2026-06-09T00:00:00Z"
}

Responses

objectKpiCardResponse

statsarray of object

Show child attributes

Show array items

current_valuenumber · double

Metric value for the current period. Unit depends on `type`: `count` is an integer count; `errors` is a percentage in [0, 100]; `avg_duration` is milliseconds; `total_cost` is in USD.

previous_valuenumber · double

Metric value for the immediately preceding period of equal length. Same unit as `current_value`.

typestring

one of "count", "errors", "avg_duration", "total_cost"

Example response

{
  "stats": [
    {
      "current_value": 0,
      "previous_value": 0,
      "type": "avg_duration"
    }
  ]
}

objectErrorMessage

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/kpi-cards' \
  -H 'Content-Type: application/json' \
  -d '{"entity_type":"spans","filters":"string","interval_end":"2026-06-09T00:00:00Z","interval_start":"2026-06-09T00:00:00Z"}'

const response = await fetch('http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/kpi-cards', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"entity_type":"spans","filters":"string","interval_end":"2026-06-09T00:00:00Z","interval_start":"2026-06-09T00:00:00Z"}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/kpi-cards', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"entity_type\":\"spans\",\"filters\":\"string\",\"interval_end\":\"2026-06-09T00:00:00Z\",\"interval_start\":\"2026-06-09T00:00:00Z\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/kpi-cards",
    headers={"Content-Type": "application/json"},
    data='{"entity_type":"spans","filters":"string","interval_end":"2026-06-09T00:00:00Z","interval_start":"2026-06-09T00:00:00Z"}',
)
print(response.json())

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"entity_type":"spans","filters":"string","interval_end":"2026-06-09T00:00:00Z","interval_start":"2026-06-09T00:00:00Z"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/kpi-cards", 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/kpi-cards");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"entity_type\":\"spans\",\"filters\":\"string\",\"interval_end\":\"2026-06-09T00:00:00Z\",\"interval_start\":\"2026-06-09T00:00:00Z\"}");
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/kpi-cards"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"entity_type\":\"spans\",\"filters\":\"string\",\"interval_end\":\"2026-06-09T00:00:00Z\",\"interval_start\":\"2026-06-09T00:00:00Z\"}"))
    .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/kpi-cards")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"entity_type\":\"spans\",\"filters\":\"string\",\"interval_end\":\"2026-06-09T00:00:00Z\",\"interval_start\":\"2026-06-09T00:00:00Z\"}"
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/kpi-cards");
request.Content = new StringContent("{\"entity_type\":\"spans\",\"filters\":\"string\",\"interval_end\":\"2026-06-09T00:00:00Z\",\"interval_start\":\"2026-06-09T00:00:00Z\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "stats": [
    {
      "current_value": 0,
      "previous_value": 0,
      "type": "avg_duration"
    }
  ]
}

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