Class Manager
GET /v1/reporting/stats/family

Get Family Stats

Responses

  • 200 application/json

    successful operation

    Hide response attributes Show response attributes object
    • onPortal integer Required

      Number of families on portal

    • startingThisMonth integer Required

      Number of families whose students' enrolment started or will start this month

    • leavingThisMonth integer Required

      Number of families whose students will no longer have an active enrolment as of the end of this calendar month.
  • 403 application/json

    Not authorized

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
GET /v1/reporting/stats/family 
curl \
 --request GET 'https://localhost/v1/reporting/stats/family'
Response examples (200) 
{
  "onPortal": 100,
  "startingThisMonth": 100,
  "leavingThisMonth": 100
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}