The Scrums.com API is planned and not yet publicly available. Endpoints and behaviour are subject to change before release.
Overview
The Observability API provides a platform-wide view of operational health, delivery performance, and risk signals across all active Service Lines. It aggregates data from execution records, capacity allocations, usage metering, and product-line signals into a unified observability surface.
This is not a metrics store you write to. Observability data is computed from the platform’s operational state. You query it to answer questions like:
- Which Service Lines are at risk of SLA breach?
- What is the delivery health score across this workspace?
- Which teams have been consistently under-utilising allocated capacity?
- Are there anomalies in agent execution that warrant investigation?
Core Concepts
Health scores
Every active Service Line has a health score (0-100) computed from a weighted set of signals. Scores are refreshed every 15 minutes. Scores below 70 are amber; scores below 50 are red.
Signal types
Risk levels
Platform risk indicators are derived from aggregated signals across all Service Lines in a workspace:
low — No signals below green; delivery on track
medium — One or more amber signals; monitor and investigate
high — One or more red signals; action required
Endpoints
GET /v1/observability
Platform observability summary for a workspace or organization.
Request
Response
GET /v1/observability/metrics
Retrieve metrics for Service Lines over a time range, with optional breakdown.
Request
Query parameters
Response
GET /v1/observability/health
Health scores and signal breakdown for all Service Lines in scope.
Request
Response
GET /v1/observability/risk
Aggregated risk assessment for a workspace. Includes risk factors, contributing Service Lines, and recommended actions.
Request
Response
Common Workflows
Weekly health review
Trend analysis before a quarterly review
Objects
Health signal
Risk factor
Best Practices
- Automate the weekly health check. Schedule a webhook or polling job to run
GET /v1/observability/risk every Monday morning. Route high severity risk factors to the right team via your integration.
- Do not use observability as a substitute for real-time alerts. Observability scores are computed every 15 minutes. For real-time incident detection, use Incidents & Alerts.
- Correlate observability signals with usage costs. Low utilisation on a
capacity Service Line combined with high invoiced cost is a commercial issue, not just a delivery one.
- Build trend views, not point-in-time views. A single health score tells you the current state. Weekly metric series tell you the direction. Direction matters more for stakeholder reporting.