> 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 errors by dimension POST https://api.respan.ai/api/pulses/errors/grouped/ Content-Type: application/json Splits failed spans by a field, such as model or customer. The signals panel narrows by a group's `error_class`, `provider` and `status` for its "Errors by model" and "Errors by customer" splits; groups that differ only by endpoint count together. Reference: https://respan.ai/docs/apis/errors/get-errors-by-dimension ## 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. ## Request ### Body (application/json) This endpoint expects an ErrorBreakdownRequest. - `group_by` (enum, required) — Field to group by. `issue` groups by error group fingerprint, `provider` by provider ID, and `status` by HTTP status code. - Allowed values: `customer_identifier`, `deployment_name`, `endpoint`, `error_class`, `fault_domain`, `issue`, `model`, `provider`, `status` - `start_time` (datetime, optional) — Start of the range, ISO 8601. A time without an offset is read as UTC. Defaults to 7 days ago, which is also used if the value can't be parsed. - `end_time` (datetime, optional) — End of the range, ISO 8601. A time without an offset is read as UTC. Defaults to now, which is also used if the value can't be parsed. - `environment` (string, optional) — Only count spans from this environment, such as `prod` or `test`. Omit it to include every environment. - `limit` (integer, optional, default: 100) — Maximum groups to return. Values above 100 are capped at 100. - `error_class` (enum, optional) — Only this error class. For several values or `is not`, use `filters`. - Allowed values: `user_invalid_request`, `user_auth_byok`, `user_quota`, `user_rate_limit`, `user_content_policy`, `user_context_window`, `user_payload_too_large`, `provider_down`, `provider_overloaded`, `provider_timeout`, `provider_rate_limit`, `respan_managed_auth`, `respan_managed_billing`, `respan_config`, `respan_internal`, `network_transient`, `client_cancelled`, `unknown` - `fault_domain` (enum, optional) — Only errors with this fault. `none` selects client cancellations. - Allowed values: `user`, `respan`, `provider`, `none` - `provider` (string, optional) — Only errors from this provider ID. - `status` (integer, optional) — Only errors with this HTTP status code. - `filters` (ErrorGroupFilters, optional) — Narrow the errors with the same filter shape as the Logs filter bar. Only these four keys are accepted; any other key is a 400. ## Response ### 200 Failed spans per group. - `group_by` (enum, required) - Allowed values: `customer_identifier`, `deployment_name`, `endpoint`, `error_class`, `fault_domain`, `issue`, `model`, `provider`, `status` - `groups` (list of ErrorBreakdownGroup, required) — Groups ordered by `count`, highest first. ## Errors ### 400 Bad Request Error Invalid `group_by` or `filters`. - `map from string to any` ### 403 Forbidden Error Forbidden: the API key is missing, invalid or expired; the key doesn't grant `logs:read` (Read access does). - `detail` (string, required) ### 429 Too Many Requests Error Rate limited. This endpoint allows 60 requests per minute per organization. - `detail` (string, required) ## Types ### ErrorGroupFilters Narrow the errors with the same filter shape as the Logs filter bar. Only these four keys are accepted; any other key is a 400. - `error_class` (ErrorGroupFilterCondition, optional) - `fault_domain` (ErrorGroupFilterCondition, optional) - `provider_id` (ErrorGroupFilterCondition, optional) - `status_code` (ErrorGroupFilterCondition, optional) ### ErrorBreakdownGroup - `group_value` (ErrorBreakdownGroupGroupValue, required) — Value of the `group_by` field: an integer for `status`, else a string. Missing values are an empty string. - `count` (integer, required) — Failed spans with this value. ### ErrorGroupFilterCondition - `operator` (enum, optional, default: ) — `""` (is any of), `not` (is none of), `in`, `empty` or `not_empty`. Allowed operators per key: `error_class` and `fault_domain` take `""`, `not`, `in`; `provider_id` takes `""`, `not`, `empty`, `not_empty`; `status_code` takes `""`, `not`. - Allowed values: ``, `not`, `in`, `empty`, `not_empty` - `value` (ErrorGroupFilterConditionValue, optional) — One value or a list. Required unless `operator` is `empty` or `not_empty`. ### ErrorBreakdownGroupGroupValue Value of the `group_by` field: an integer for `status`, else a string. Missing values are an empty string. ### ErrorGroupFilterConditionValue One value or a list. Required unless `operator` is `empty` or `not_empty`. ## Examples **Request** ```json { "group_by": "model", "start_time": "2026-09-30T00:00:00Z", "end_time": "2026-10-01T00:00:00Z", "limit": 10, "error_class": "provider_rate_limit", "provider": "openai", "status": 429 } ``` **Response** ```json { "group_by": "model", "groups": [ { "group_value": "gpt-4o", "count": 212 }, { "group_value": "gpt-4o-mini", "count": 106 } ] } ``` **SDK Code** ```python Error Groups_getErrorBreakdown_example import requests url = "https://api.respan.ai/api/pulses/errors/grouped/" payload = { "group_by": "model", "start_time": "2026-09-30T00:00:00Z", "end_time": "2026-10-01T00:00:00Z", "limit": 10, "error_class": "provider_rate_limit", "provider": "openai", "status": 429 } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Error Groups_getErrorBreakdown_example const url = 'https://api.respan.ai/api/pulses/errors/grouped/'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"group_by":"model","start_time":"2026-09-30T00:00:00Z","end_time":"2026-10-01T00:00:00Z","limit":10,"error_class":"provider_rate_limit","provider":"openai","status":429}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Error Groups_getErrorBreakdown_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.respan.ai/api/pulses/errors/grouped/" payload := strings.NewReader("{\n \"group_by\": \"model\",\n \"start_time\": \"2026-09-30T00:00:00Z\",\n \"end_time\": \"2026-10-01T00:00:00Z\",\n \"limit\": 10,\n \"error_class\": \"provider_rate_limit\",\n \"provider\": \"openai\",\n \"status\": 429\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 Error Groups_getErrorBreakdown_example require 'uri' require 'net/http' url = URI("https://api.respan.ai/api/pulses/errors/grouped/") 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 \"group_by\": \"model\",\n \"start_time\": \"2026-09-30T00:00:00Z\",\n \"end_time\": \"2026-10-01T00:00:00Z\",\n \"limit\": 10,\n \"error_class\": \"provider_rate_limit\",\n \"provider\": \"openai\",\n \"status\": 429\n}" response = http.request(request) puts response.read_body ``` ```java Error Groups_getErrorBreakdown_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.respan.ai/api/pulses/errors/grouped/") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"group_by\": \"model\",\n \"start_time\": \"2026-09-30T00:00:00Z\",\n \"end_time\": \"2026-10-01T00:00:00Z\",\n \"limit\": 10,\n \"error_class\": \"provider_rate_limit\",\n \"provider\": \"openai\",\n \"status\": 429\n}") .asString(); ``` ```php Error Groups_getErrorBreakdown_example request('POST', 'https://api.respan.ai/api/pulses/errors/grouped/', [ 'body' => '{ "group_by": "model", "start_time": "2026-09-30T00:00:00Z", "end_time": "2026-10-01T00:00:00Z", "limit": 10, "error_class": "provider_rate_limit", "provider": "openai", "status": 429 }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Error Groups_getErrorBreakdown_example using RestSharp; var client = new RestClient("https://api.respan.ai/api/pulses/errors/grouped/"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"group_by\": \"model\",\n \"start_time\": \"2026-09-30T00:00:00Z\",\n \"end_time\": \"2026-10-01T00:00:00Z\",\n \"limit\": 10,\n \"error_class\": \"provider_rate_limit\",\n \"provider\": \"openai\",\n \"status\": 429\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Error Groups_getErrorBreakdown_example import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "group_by": "model", "start_time": "2026-09-30T00:00:00Z", "end_time": "2026-10-01T00:00:00Z", "limit": 10, "error_class": "provider_rate_limit", "provider": "openai", "status": 429 ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.respan.ai/api/pulses/errors/grouped/")! 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() ```