Usage Summary
free/v1/analytics/usageReturns a comprehensive summary of your API usage for the selected period including total requests, breakdown by endpoint category (DNS, domain, security, IP, network, scores, etc.), daily request trends, and quota utilization against your plan limits. Aligns with the SRE Golden Signals "Traffic" metric — understanding request volume is the foundation of capacity planning and cost management.
What It Does
Aggregates API request data from usage logs for the authenticated organization. Calculates total requests for the selected period, groups request counts by endpoint category, generates daily breakdown timeseries, and computes quota utilization as a percentage of your plan limit. Period options: 7d (last 7 days), 30d (last 30 days), or current (current billing period, default). Quota limits vary by tier: Free (1,000/month), Developer (50,000/month), Pro (500,000/month), Enterprise (10M/month).
Why It's Useful
Request volume visibility is the first step in the FinOps "Inform" phase — you cannot optimize what you cannot measure. This endpoint provides the baseline data needed for capacity planning, budget forecasting, and anomaly detection. Track usage patterns to anticipate tier upgrades, identify unexpected traffic spikes that may indicate misconfigured integrations, and ensure your applications stay within plan quotas to avoid service interruptions.
Use Cases
Quota Monitoring & Limit Prevention
Check current usage against your monthly quota in CI/CD pipelines or monitoring dashboards. Set alerts at 70%, 80%, and 90% thresholds to prevent hitting quota limits mid-month. Review category breakdown to identify which endpoint groups drive the most usage.
Prevent unexpected service interruptions by proactively tracking quota consumption across all applications.
Capacity Planning & Tier Selection
Review 30-day usage trends to forecast monthly consumption. Compare projected usage against current tier limits and higher-tier pricing to make data-driven upgrade decisions. Track usage growth rate to anticipate when upgrades will be needed.
Right-size your API plan based on actual consumption data rather than guesswork — avoid both overpaying and hitting limits.
Usage Anomaly Detection
Monitor daily request volumes for unexpected spikes or drops that may indicate compromised API keys, misconfigured retry loops, or application failures. Compare current period usage against previous periods to establish baselines.
Early detection of abnormal usage patterns that could indicate security issues or integration bugs.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
period | string | Optional | Time range for usage data: 7d (last 7 days), 30d (last 30 days), or current (current billing period). Default: current.Example: 30d |
Response Fields
| Field | Type | Description |
|---|---|---|
total_requests | number | Total API requests in the selected period |
by_category | object | Request counts by endpoint category (dns, domain, security, ip, etc.) |
daily_breakdown | array | Daily request counts as timeseries [{date, count}, ...] |
quota | object | Plan quota details: limit, used, remaining, percentage_used |
Code Examples
curl "https://api.edgedns.dev/v1/analytics/usage" \
-H "Authorization: Bearer YOUR_API_KEY"const response = await fetch(
'https://api.edgedns.dev/v1/analytics/usage',
{
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/usage',
headers={'Authorization': 'Bearer YOUR_API_KEY'},
params={
}
)
data = response.json()
print(data)Read the full Usage Summary 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 Usage Summary endpoint live in the playground.