Developer portal
GET /tenant/benchmarks
Compare tenant readiness against industry benchmark cohorts.
PilotGET /tenant/benchmarksAuth: viewer | operator | admin
Summary
Compare tenant readiness against industry benchmark cohorts.
Example
curl
curl "https://sparkling-vibrancy-production-1a7a.up.railway.app/tenant/benchmarks" \
-H "Authorization: Bearer 811f31d4-5b8e-4ed0-a7a2-8176e05eba63"Response
| Field | Type | Required | Description |
|---|---|---|---|
| index | object | Yes | Industry benchmark index snapshot. |
| comparison | object | null | No | Tenant-vs-cohort comparison metrics. |
| benchmarkOptIn | boolean | Yes | Whether tenant has opted into benchmarks. |
Errors
| Code | Meaning | Typical cause | Suggested fix |
|---|---|---|---|
| 401 | Unauthorized | Missing or invalid API key in Authorization, x-api-key, or query param. | Send Bearer <key> or x-api-key with a valid tenant token. |
| 403 | Forbidden | Valid key but insufficient role (viewer attempting write) or wrong admin key. | Use operator or admin role key; check RBAC matrix. |
| 404 | Not found | Scan, schedule, share link, or resource id does not exist or expired. | Verify id and tenant scope; share links expire per expiresHours. |
| 422 | Unprocessable entity | Invalid payload shape, unsupported scenario, or infeasible constraints. | Fix field errors in response detail; relax constraints and retry. |
| 429 | Too many requests | Per-key rate limit exceeded (default 300 requests per minute) or public endpoint limit. | Backoff with jitter; cache results; request higher limit for production. |
| 500 | Internal server error | Unexpected backend failure; includes requestId in response. | Retry with exponential backoff; contact support with requestId if persistent. |
| 503 | Service unavailable | Persistence disabled, auth DB unreachable, or admin API not configured. | Retry shortly; schedules require Postgres persistence enabled. |
See the full errors reference.
Found an issue? Report documentation feedback