> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://respan.ai/docs/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://respan.ai/docs/_mcp/server. # Get span summary POST https://api.respan.ai/api/request-logs/summary/ Content-Type: application/json Returns aggregate span statistics for a time range. Send `start_time`, `end_time`, and `environment` as query parameters, and additional `filters` in the JSON body. Fields such as `log_type` are not read from query parameters. Empty or omitted `filters` may use pre-aggregated data; non-empty `filters` query individual spans using the List spans filter format. Reference: https://respan.ai/docs/apis/spans/get-span-summary ## Authentication - `Authorization` header (bearer token, required) — Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer \. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan\_params.credential\_override in the request body, not in this authentication field. - `Authorization` header (bearer token, required) — Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead. ## Request ### Query parameters - `start_time` (datetime, optional) — Start of time range (ISO 8601). - `end_time` (datetime, optional) — End of time range (ISO 8601). - `environment` (enum, optional) — Filter by environment (`prod` or `test`). - Allowed values: `prod`, `test` ### Body (application/json) This endpoint expects an object. - `filters` (Filters, optional) — Each key is a field to filter on, and each value is a condition: `{"": {"operator": "", "value": [...]}}`. A span must match every condition. To set two conditions on one field, such as a range, pass a list of conditions. **Operators:** `""` (equals, the default), `not`, `in`, `not_in`, `lt`, `lte`, `gt`, `gte`, `contains`, `not_contains`, `icontains` (ignores case), `startswith`, `not_startswith`, `endswith`, `not_endswith`, `empty`, `not_empty`. Put values in a list: `""` and `in` match any of the listed values, and `not` and `not_in` match none of them. Other operators take one value; for `empty` and `not_empty`, send `[""]`. **Fields:** * `unique_id`, `trace_unique_id`, `span_unique_id`, `span_parent_id`, `span_name`, `span_workflow_name`, `thread_identifier`, `customer_identifier`, `customer_email`, `custom_identifier`, `group_identifier`, `evaluation_identifier`, `organization_key_id`, `prompt_id`, `prompt_name`, `prompt_version_number`, `model`, `provider_id`, `deployment_name`, `log_type`, `log_method`, `status`, `status_code`, `environment`, `error_class`, `error_code`, `error_message`, `error_fingerprint`, `cache_key`, `note` * True or false: `stream`, `has_tool_calls`, `cache_bit`, `used_custom_credential`, `positive_feedback` * Numbers: `cost`, `latency`, `time_to_first_token`, `tokens_per_second`, `routing_time`, `prompt_tokens`, `completion_tokens`, `total_request_tokens`, `prompt_cache_hit_tokens`, `prompt_cache_creation_tokens`. The aliases `total_cost`, `input_tokens`, `output_tokens` and `total_tokens` also work, and so does `trace_id` for `trace_unique_id`. * `metadata__`: a custom metadata value. Values are strings, and spans without the key never match, even with `not`. * `scores__`: an evaluator's numeric score, with `""`, `not`, `in`, `not_in`, `lt`, `lte`, `gt` or `gte`. * `is_root_span` (`[true]` or `[false]`), `fault_domain` (`user`, `respan` or `provider`), and `behaviors` (spans where the named behaviors fired, when span behaviors are on). Unsupported fields return a 400 error. **Example:** ```json { "customer_identifier": {"operator": "", "value": ["alex@acme.dev"]}, "status_code": {"operator": "not", "value": [200]} } ``` ## Response ### 200 Summary statistics for matching spans. - `number_of_requests` (integer, required) — Total number of matching spans/log rows. - `total_cost` (double, required) — Total cost in USD for all matching spans/log rows. - `total_tokens` (integer, required) — Total tokens across all matching spans/log rows. - `total_prompt_tokens` (integer, required) — Total prompt/input tokens. - `total_completion_tokens` (integer, required) — Total completion/output tokens. - `avg_latency` (double, required) — Average latency in seconds. - `avg_tps` (double, required) — Average tokens per second. - `avg_ttft` (double, required) — Average time to first token in seconds. - `scores` (map from string to any, required) — Aggregated score summaries grouped by evaluator ID. ## Errors ### 400 Bad Request Error Bad Request - `error` (string, optional) — Error message ### 403 Forbidden Error The API key is missing, invalid or expired. - `detail` (string, required) ### 413 Content Too Large Error The query exceeded the service's memory or execution-time limit. Narrow the time range or add filters before retrying. - `detail` (string, required) ### 429 Too Many Requests Error Rate Limited - `error` (string, optional) — Error message ### 500 Internal Server Error Internal Server Error - `error` (string, optional) — Error message ## Types ### Filters Each key is a field to filter on, and each value is a condition: `{"": {"operator": "", "value": [...]}}`. A result must match every condition. To set two conditions on one field, such as a range, pass a list of conditions. **Operators:** `""` (equals, the default), `not`, `in`, `not_in`, `lt`, `lte`, `gt`, `gte`, `contains`, `not_contains`, `icontains` (ignores case), `startswith`, `not_startswith`, `endswith`, `not_endswith`, `empty`, `not_empty`. Put values in a list: `""` and `in` match any of the listed values, and `not` and `not_in` match none of them. Other operators take one value; for `empty` and `not_empty`, send `[""]`. The fields you can filter on depend on the endpoint; `metadata__` filters custom metadata where the endpoint supports it. - `status` (FilterValue, optional) — A filter condition with an operator and value. - `status_code` (FilterValue, optional) — A filter condition with an operator and value. - `unique_id` (FilterValue, optional) — A filter condition with an operator and value. - `customer_identifier` (FilterValue, optional) — A filter condition with an operator and value. - `thread_identifier` (FilterValue, optional) — A filter condition with an operator and value. - `custom_identifier` (FilterValue, optional) — A filter condition with an operator and value. - `group_identifier` (FilterValue, optional) — A filter condition with an operator and value. - `prompt_id` (FilterValue, optional) — A filter condition with an operator and value. - `trace_unique_id` (FilterValue, optional) — A filter condition with an operator and value. - `span_parent_id` (FilterValue, optional) — A filter condition with an operator and value. - `is_root_span` (FilterValue, optional) — A filter condition with an operator and value. - `span_workflow_name` (FilterValue, optional) — A filter condition with an operator and value. - `span_name` (FilterValue, optional) — A filter condition with an operator and value. - `model` (FilterValue, optional) — A filter condition with an operator and value. - `log_type` (FilterValue, optional) — A filter condition with an operator and value. - `stream` (FilterValue, optional) — A filter condition with an operator and value. - `has_tool_calls` (FilterValue, optional) — Whether the span made tool calls. - `cache_bit` (FilterValue, optional) — Whether the response was served from the Respan cache. - `cache_key` (FilterValue, optional) — A filter condition with an operator and value. - `prompt_tokens` (FilterValue, optional) — A filter condition with an operator and value. - `completion_tokens` (FilterValue, optional) — A filter condition with an operator and value. - `total_tokens` (FilterValue, optional) — A filter condition with an operator and value. - `cost` (FilterValue, optional) — A filter condition with an operator and value. - `latency` (FilterValue, optional) — A filter condition with an operator and value. - `positive_feedback` (FilterValue, optional) — A filter condition with an operator and value. ### FilterValue A filter condition with an operator and value. - `value` (list of any, required) — Value(s) to filter by. - `operator` (enum, optional, default: ) — Comparison operator. An empty string means equals. - Allowed values: ``, `not`, `in`, `not_in`, `lt`, `lte`, `gt`, `gte`, `contains`, `not_contains`, `icontains`, `startswith`, `not_startswith`, `endswith`, `not_endswith`, `empty`, `not_empty` ## Examples ### Filter by span/log type **Request** ```json { "filters": { "log_type": { "value": [ "chat" ], "operator": "" } } } ``` **Response** ```json { "number_of_requests": 1, "total_cost": 0, "total_tokens": 0, "total_prompt_tokens": 0, "total_completion_tokens": 0, "avg_latency": 0, "avg_tps": 0, "avg_ttft": 0, "scores": {} } ``` **SDK Code** ```python Filter by span/log type import requests url = "https://api.respan.ai/api/request-logs/summary/" querystring = {"start_time":"2025-01-01T00:00:00Z","end_time":"2025-01-31T23:59:59Z","environment":"prod"} payload = { "filters": { "log_type": { "value": ["chat"], "operator": "" } } } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers, params=querystring) print(response.json()) ``` ```javascript Filter by span/log type const url = 'https://api.respan.ai/api/request-logs/summary/?start_time=2025-01-01T00%3A00%3A00Z&end_time=2025-01-31T23%3A59%3A59Z&environment=prod'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"filters":{"log_type":{"value":["chat"],"operator":""}}}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Filter by span/log type package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.respan.ai/api/request-logs/summary/?start_time=2025-01-01T00%3A00%3A00Z&end_time=2025-01-31T23%3A59%3A59Z&environment=prod" payload := strings.NewReader("{\n \"filters\": {\n \"log_type\": {\n \"value\": [\n \"chat\"\n ],\n \"operator\": \"\"\n }\n }\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") 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 Filter by span/log type require 'uri' require 'net/http' url = URI("https://api.respan.ai/api/request-logs/summary/?start_time=2025-01-01T00%3A00%3A00Z&end_time=2025-01-31T23%3A59%3A59Z&environment=prod") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"filters\": {\n \"log_type\": {\n \"value\": [\n \"chat\"\n ],\n \"operator\": \"\"\n }\n }\n}" response = http.request(request) puts response.read_body ``` ```java Filter by span/log type import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.respan.ai/api/request-logs/summary/?start_time=2025-01-01T00%3A00%3A00Z&end_time=2025-01-31T23%3A59%3A59Z&environment=prod") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"filters\": {\n \"log_type\": {\n \"value\": [\n \"chat\"\n ],\n \"operator\": \"\"\n }\n }\n}") .asString(); ``` ```php Filter by span/log type request('POST', 'https://api.respan.ai/api/request-logs/summary/?start_time=2025-01-01T00%3A00%3A00Z&end_time=2025-01-31T23%3A59%3A59Z&environment=prod', [ 'body' => '{ "filters": { "log_type": { "value": [ "chat" ], "operator": "" } } }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Filter by span/log type using RestSharp; var client = new RestClient("https://api.respan.ai/api/request-logs/summary/?start_time=2025-01-01T00%3A00%3A00Z&end_time=2025-01-31T23%3A59%3A59Z&environment=prod"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"filters\": {\n \"log_type\": {\n \"value\": [\n \"chat\"\n ],\n \"operator\": \"\"\n }\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Filter by span/log type import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["filters": ["log_type": [ "value": ["chat"], "operator": "" ]]] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.respan.ai/api/request-logs/summary/?start_time=2025-01-01T00%3A00%3A00Z&end_time=2025-01-31T23%3A59%3A59Z&environment=prod")! 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() ``` ### Example 2 **Request** ```json { "filters": { "log_type": { "value": [ "chat" ], "operator": "" } } } ``` **Response** ```json { "number_of_requests": 1, "total_cost": 0, "total_tokens": 0, "total_prompt_tokens": 0, "total_completion_tokens": 0, "avg_latency": 0, "avg_tps": 0, "avg_ttft": 0, "scores": {} } ``` **SDK Code** ```python import requests url = "https://api.respan.ai/api/request-logs/summary/" querystring = {"start_time":"2025-01-01T00:00:00Z","end_time":"2025-01-31T23:59:59Z","environment":"prod"} payload = { "filters": { "log_type": { "value": ["chat"], "operator": "" } } } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://api.respan.ai/api/request-logs/summary/?start_time=2025-01-01T00%3A00%3A00Z&end_time=2025-01-31T23%3A59%3A59Z&environment=prod'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"filters":{"log_type":{"value":["chat"],"operator":""}}}' }; 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 := "https://api.respan.ai/api/request-logs/summary/?start_time=2025-01-01T00%3A00%3A00Z&end_time=2025-01-31T23%3A59%3A59Z&environment=prod" payload := strings.NewReader("{\n \"filters\": {\n \"log_type\": {\n \"value\": [\n \"chat\"\n ],\n \"operator\": \"\"\n }\n }\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") 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("https://api.respan.ai/api/request-logs/summary/?start_time=2025-01-01T00%3A00%3A00Z&end_time=2025-01-31T23%3A59%3A59Z&environment=prod") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"filters\": {\n \"log_type\": {\n \"value\": [\n \"chat\"\n ],\n \"operator\": \"\"\n }\n }\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.respan.ai/api/request-logs/summary/?start_time=2025-01-01T00%3A00%3A00Z&end_time=2025-01-31T23%3A59%3A59Z&environment=prod") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"filters\": {\n \"log_type\": {\n \"value\": [\n \"chat\"\n ],\n \"operator\": \"\"\n }\n }\n}") .asString(); ``` ```php request('POST', 'https://api.respan.ai/api/request-logs/summary/?start_time=2025-01-01T00%3A00%3A00Z&end_time=2025-01-31T23%3A59%3A59Z&environment=prod', [ 'body' => '{ "filters": { "log_type": { "value": [ "chat" ], "operator": "" } } }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.respan.ai/api/request-logs/summary/?start_time=2025-01-01T00%3A00%3A00Z&end_time=2025-01-31T23%3A59%3A59Z&environment=prod"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"filters\": {\n \"log_type\": {\n \"value\": [\n \"chat\"\n ],\n \"operator\": \"\"\n }\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["filters": ["log_type": [ "value": ["chat"], "operator": "" ]]] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.respan.ai/api/request-logs/summary/?start_time=2025-01-01T00%3A00%3A00Z&end_time=2025-01-31T23%3A59%3A59Z&environment=prod")! 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() ```