Skip to main content
GET
/
v1
/
analytics
/
cases
Case statistics
curl --request GET \
  --url https://instance.prod.onboardapp.io/v1/analytics/cases \
  --header 'X-API-KEY: <api-key>'
{
  "data": {
    "total": 123,
    "opened": 123,
    "closed": 123,
    "escalated": 123,
    "throughput_rate": 123,
    "average_age_days": 123,
    "breakdown": [
      {
        "label": "<string>",
        "count": 123,
        "percentage": 123
      }
    ],
    "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 (ISO 8601).

to
string<date-time>

End date (ISO 8601).

group_by
enum<string>
default:status

Group results by dimension.

Available options:
type,
status,
risk_tier,
entity_category

Response

Case statistics.

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

data
object

Case-specific statistics and trends.

meta
object