Skip to main content
GET
/
v1
/
analytics
/
summary
Summary metrics
curl --request GET \
  --url https://instance.prod.onboardapp.io/v1/analytics/summary \
  --header 'X-API-KEY: <api-key>'
{
  "data": {
    "open_cases": 123,
    "pending_alerts": 123,
    "sla_health_percentage": 123,
    "average_case_resolution_days": 123,
    "average_alert_resolution_hours": 123,
    "cases_by_status": {},
    "alerts_by_priority": {},
    "risk_tier_distribution": {},
    "period": {
      "from": "2023-11-07T05:31:56Z",
      "to": "2023-11-07T05:31:56Z"
    }
  },
  "meta": {
    "request_id": "req_9k4m2n1p3q",
    "page": {
      "cursor": "<string>",
      "has_more": true
    }
  }
}

Authorizations

​
X-API-KEY
string
header
required

Project-scoped API key for server-to-server authentication. Obtain keys from the Zenoo dashboard under Project Settings > API Keys. Staging and production environments use separate keys.

Query Parameters

​
from
string<date-time>

Start date for metrics period (ISO 8601).

​
to
string<date-time>

End date for metrics period (ISO 8601).

Response

Summary metrics.

Standard response wrapper for all API endpoints. Contains the resource data and pagination metadata.

​
data
object

Key compliance KPIs and summary metrics.

​
meta
object