Error Breakdown
developer/v1/analytics/errorsReturns detailed error statistics — total errors, overall error rate, breakdown by HTTP status category (4xx client errors, 5xx server errors), errors by endpoint, error trends over time, and most common error messages. Implements the SRE Golden Signals "Errors" metric. Error rate is a direct indicator of integration health and service reliability.
What It Does
Aggregates error data across all API requests for the authenticated organization in the selected period. Categorizes errors by HTTP status code family (4xx client errors vs 5xx server errors), identifies which endpoints have the highest error rates, provides a timeseries of error trends, and surfaces the most common error messages for debugging. Period options: 7d, 30d, or current (default). A 4xx error typically indicates a client-side issue (bad parameters, authentication failure), while 5xx indicates a server-side issue.
Why It's Useful
Error rate is one of the four SRE Golden Signals and a primary indicator of service reliability. Elevated 4xx rates usually indicate integration problems — wrong parameters, expired keys, or exceeded rate limits — that are entirely within your control to fix. The error breakdown by endpoint quickly narrows investigation scope, and common error messages provide the specific context needed for resolution. Tracking error trends over time helps correlate spikes with deployments, configuration changes, or upstream issues.
Use Cases
Integration Error Debugging
Investigate which API calls are failing and why. Filter by error type (4xx vs 5xx) to determine if the issue is client-side or server-side. Use per-endpoint error rates to pinpoint which integration points need attention. Review common error messages for specific fix guidance.
Reduce mean time to resolution by quickly identifying the root cause — specific endpoint, error type, and error message.
SLA & Quality Monitoring
Track overall error rates against SLA targets (e.g., < 1% error rate). Monitor error trends to detect regressions after deployments. Set up alerts when error rates exceed thresholds across any endpoint or time window.
Maintain service reliability commitments with continuous error monitoring and trend-based alerting.
Post-Deployment Validation
Compare error rates before and after deployments to catch integration regressions. Check if new code introduced incorrect API parameters, broke authentication flows, or triggered rate limiting. Use the timeseries to correlate error spikes with deployment timestamps.
Catch deployment-related API integration issues within minutes instead of waiting for user reports.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
period | string | Optional | Time range: 7d (last 7 days), 30d (last 30 days), or current (current billing period). Default: current.Example: 7d |
Response Fields
| Field | Type | Description |
|---|---|---|
total_errors | number | Total error count in the period |
error_rate | number | Error rate as percentage of total requests |
by_type | object | Errors by HTTP status category: 4xx (client) and 5xx (server) counts and rates |
by_endpoint | array | Errors per endpoint: path, error_count, error_rate, top_status_codes |
timeline | array | Error trends over time [{timestamp, total, rate, by_type}, ...] |
common_messages | array | Most frequent error messages with occurrence count |
Code Examples
curl "https://api.edgedns.dev/v1/analytics/errors" \
-H "Authorization: Bearer YOUR_API_KEY"const response = await fetch(
'https://api.edgedns.dev/v1/analytics/errors',
{
headers: {
'Authorization': 'Bearer YOUR_API_KEY'
}
}
);
const data = await response.json();
console.log(data);import requests
response = requests.get(
'https://api.edgedns.dev/v1/analytics/errors',
headers={'Authorization': 'Bearer YOUR_API_KEY'},
params={
}
)
data = response.json()
print(data)Read the full Error Breakdown guide
Why it matters, real-world use cases, parameters, response fields, and how to call it from Claude, ChatGPT, or Gemini via MCP.
Read the guide →Related Endpoints
External References
Learn more about the standards and protocols behind this endpoint.
Try This Endpoint
Test the Error Breakdown endpoint live in the playground.