Skip to main content
The Puzzle Section
Get Started

Analytics API

Monitor your tenant's API usage, request volumes, and error rates. Requires tenant API key and Starter tier or above.

Tier Requirement

Analytics endpoints require the Starter plan or above. Free-tier tenants receive a 403 INSUFFICIENT_TIER response.

GET/api/v1/analytics/usage

Usage Analytics

Returns API request volumes, success/error rates, rate-limited request counts, bandwidth consumption, and per-API-key breakdowns for your tenant.

Query Parameters

ParameterTypeDescription
rangestringPreset range: 7d, 30d, 90d
startDatestringISO date (YYYY-MM-DD). Used with endDate for a custom range.
endDatestringISO date (YYYY-MM-DD)

Example

bash
curl -X GET "https://api.puzzlesection.app/api/v1/analytics/usage?range=30d" \
  -H "X-API-Key: ps_live_xxxxxxxxxxxx"

Response 200

JSON
1{
2  "success": true,
3  "data": {
4    "totalRequests": 48210,
5    "successfulRequests": 47893,
6    "failedRequests": 317,
7    "rateLimitedRequests": 12,
8    "bandwidthUsed": "124.5 MB",
9    "timeSeries": [
10      { "date": "2026-02-03", "requests": 1580, "errors": 8 },
11      { "date": "2026-02-04", "requests": 1643, "errors": 12 }
12    ],
13    "byApiKey": [
14      {
15        "apiKeyId": "key-uuid",
16        "name": "Production",
17        "requests": 45000,
18        "errors": 280
19      },
20      {
21        "apiKeyId": "key-uuid-2",
22        "name": "Staging",
23        "requests": 3210,
24        "errors": 37
25      }
26    ]
27  }
28}