Family overview report

GET/families/{familyID}/reports/overview

Get a health dashboard for a family: children, active policies, enforcement status, and recommendations.

Auth:Bearer

Path parameters

familyID

uuidrequired

Response

children

object[]

total_platforms

integer

enforcement_health

healthy | warning | error

recent_enforcements

object[]

Request

bash

curl -X GET "https://api.phosra.com/api/v1/families/{familyID}/reports/overview" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

json

{
  "children": [
    {
      "child": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "family_id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "string",
        "birth_date": "2018-06-15",
        "avatar_url": "string",
        "created_at": "2025-01-15T09:30:00Z"
      },
      "active_policies": 0,
      "last_enforcement_at": "2025-01-15T09:30:00Z",
      "enforcement_status": "string"
    }
  ],
  "total_platforms": 0,
  "enforcement_health": "healthy",
  "recent_enforcements": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "child_id": "550e8400-e29b-41d4-a716-446655440000",
      "policy_id": "550e8400-e29b-41d4-a716-446655440000",
      "trigger_type": "manual",
      "status": "pending",
      "started_at": "2025-01-15T09:30:00Z",
      "completed_at": "2025-01-15T09:30:00Z",
      "created_at": "2025-01-15T09:30:00Z"
    }
  ]
}