Get costs summary | Opik Documentation

POST/v1/private/workspaces/costs/summariesGet costs summary

Get costs summary

Request body

application/json

objectWorkspaceMetricsSummaryRequest

interval_endstring · date-timerequired

interval_startstring · date-timerequired

project_idsarray of string · uuid

uniqueItems true

Show child attributes

uniqueItems true

start_before_endboolean

Example request

{
  "interval_end": "2026-06-09T00:00:00Z",
  "interval_start": "2026-06-09T00:00:00Z",
  "project_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "start_before_end": true
}

Responses

objectResult

currentnumber · double

namestring

previousnumber · double

Example response

{
  "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/costs/summaries' \
  -H 'Content-Type: application/json' \
  -d '{"interval_end":"2026-06-09T00:00:00Z","interval_start":"2026-06-09T00:00:00Z","project_ids":["00000000-0000-0000-0000-000000000000"],"start_before_end":true}'

const response = await fetch('http://localhost:5173/api/v1/private/workspaces/costs/summaries', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"interval_end":"2026-06-09T00:00:00Z","interval_start":"2026-06-09T00:00:00Z","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/costs/summaries', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"interval_end\":\"2026-06-09T00:00:00Z\",\"interval_start\":\"2026-06-09T00:00:00Z\",\"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/costs/summaries",
    headers={"Content-Type": "application/json"},
    data='{"interval_end":"2026-06-09T00:00:00Z","interval_start":"2026-06-09T00:00:00Z","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(`{"interval_end":"2026-06-09T00:00:00Z","interval_start":"2026-06-09T00:00:00Z","project_ids":["00000000-0000-0000-0000-000000000000"],"start_before_end":true}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/workspaces/costs/summaries", 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/costs/summaries");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"interval_end\":\"2026-06-09T00:00:00Z\",\"interval_start\":\"2026-06-09T00:00:00Z\",\"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/costs/summaries"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"interval_end\":\"2026-06-09T00:00:00Z\",\"interval_start\":\"2026-06-09T00:00:00Z\",\"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/costs/summaries")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"interval_end\":\"2026-06-09T00:00:00Z\",\"interval_start\":\"2026-06-09T00:00:00Z\",\"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/costs/summaries");
request.Content = new StringContent("{\"interval_end\":\"2026-06-09T00:00:00Z\",\"interval_start\":\"2026-06-09T00:00:00Z\",\"project_ids\":[\"00000000-0000-0000-0000-000000000000\"],\"start_before_end\":true}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "current": 0,
  "name": "string",
  "previous": 0
}

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