Admin - Business Dashboards

Get Retention Usage Dashboard

Changed on
get/admin/business-dashboards/retention-usage

Request

  • Base URL
    https://api.excellence-ai.com (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URLapi/login

Query parameters

weeksinteger

Response

Successful Response

weeks_analyzedinteger required
analysis_start_datestring date-time required
analysis_end_datestring date-time required
wat_currentinteger required
was_currentinteger required
teacher_churn_currentnumber required
student_churn_currentnumber required
school_churn_currentnumber required
teacher_true_churn_currentnumber required
student_true_churn_currentnumber required
school_true_churn_currentnumber required
contract_renewal_ratenumber nullable
contracts_endedinteger
contracts_renewedinteger
contracts_pending_renewalinteger

Changes

    • breaking

      removed the required property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status