> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://www.comet.com/docs/opik/llms.txt.

# Get workspace span metric

POST http://localhost:5173/api/v1/private/workspaces/metrics/spans
Content-Type: application/json

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.

Reference: https://www.comet.com/docs/opik/reference/rest-api/workspaces/get-workspace-span-metric

## Servers

- `http://localhost:5173/api` (Local server, default)
- `https://www.comet.com/opik/api` (Opik Cloud)

## Request

### Body (application/json)

This endpoint expects a WorkspaceSpanMetricRequest.

- `interval_start` (datetime, required)
- `project_ids` (list of string, optional)
- `metric_type` (enum, optional)
  - Allowed values: `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`
- `interval` (enum, optional)
  - Allowed values: `HOURLY`, `DAILY`, `WEEKLY`, `TOTAL`
- `breakdown` (BreakdownConfig, optional)
- `filters` (list of SpanFilter, optional)
- `interval_end` (datetime, optional)
- `start_before_end` (boolean, optional)

## Response

### 200

Workspace span metric

- `results` (list of Result, optional)

## Errors

### 400 Bad Request Error

Bad Request

- `code` (integer, optional)
- `message` (string, optional)
- `details` (string, optional)

## Types

### BreakdownConfig

- `field` (enum, optional)
  - Allowed values: `none`, `tags`, `metadata`, `name`, `error_info`, `error_type`, `model`, `provider`, `type`, `guardrail_name`
- `metadata_key` (string, optional)
- `sub_metric` (string, optional)

### SpanFilter

- `field` (string, optional)
- `operator` (enum, optional)
  - Allowed values: `contains`, `not_contains`, `starts_with`, `ends_with`, `=`, `!=`, `>`, `>=`, `<`, `<=`, `is_empty`, `is_not_empty`, `in`, `not_in`
- `key` (string, optional)
- `value` (string, optional)

### Result

- `name` (string, optional)
- `current` (double, optional)
- `previous` (double, optional)

## Examples

**Request**

```json
{
  "interval_start": "2024-01-15T09:30:00Z"
}
```

**Response**

```json
{
  "results": [
    {
      "name": "string",
      "current": 1.1,
      "previous": 1.1
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "http://localhost:5173/api/v1/private/workspaces/metrics/spans"

payload = { "interval_start": "2024-01-15T09:30:00Z" }
headers = {"Content-Type": "application/json"}

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

print(response.json())
```

```javascript
const url = 'http://localhost:5173/api/v1/private/workspaces/metrics/spans';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"interval_start":"2024-01-15T09:30:00Z"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:5173/api/v1/private/workspaces/metrics/spans"

	payload := strings.NewReader("{\n  \"interval_start\": \"2024-01-15T09:30:00Z\"\n}")

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

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("http://localhost:5173/api/v1/private/workspaces/metrics/spans")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"interval_start\": \"2024-01-15T09:30:00Z\"\n}"

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("http://localhost:5173/api/v1/private/workspaces/metrics/spans")
  .header("Content-Type", "application/json")
  .body("{\n  \"interval_start\": \"2024-01-15T09:30:00Z\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'http://localhost:5173/api/v1/private/workspaces/metrics/spans', [
  'body' => '{
  "interval_start": "2024-01-15T09:30:00Z"
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("http://localhost:5173/api/v1/private/workspaces/metrics/spans");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"interval_start\": \"2024-01-15T09:30:00Z\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = ["interval_start": "2024-01-15T09:30:00Z"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:5173/api/v1/private/workspaces/metrics/spans")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```