v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve compliance statistics

This API retrieves all compliance statistics of an organization.

get/{api_url}/v1/organizations/treatment_forms/compliance_rule_statistics

Query parameters

start_dateboolean

start date of appts to be considered

end_dateboolean

end date of appts to be considered

center_idsstring

list of centers

jobsstring

list of jobs

employee_idsstring

list of employees

Response

200

{"stackTrail":"paths:/{api_url}/v1/organizations/treatment_forms/compliance_rule_statistics:get:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown"}

Example response

{
  "compliance_rule_statistics": [
    {
      "compliance_rule_id": 2,
      "organization_id": "3e2d70ea-4cff-410e-a834-86b352e43bc8",
      "center_id": "34f7b069-1bce-4f24-b9b2-f58ebbf768f0",
      "center_name": "Hyderabad",
      "state": "Select State",
      "jobs": [
        {
          "id": "75298383-885c-4482-9077-4683eabf8b26",
          "name": "THERAPIST"
        }
      ],
      "target_percentage": 70,
      "total_forms": 206,
      "submitted_forms": 36,
      "submission_percentage": 17,
      "reviewed_forms": 12,
      "review_percentage": 5,
      "employee_statistics": [
        {
          "employee_id": "8e2ba871-bce1-43f7-901b-22a53ae6c24e",
          "name": "emp1 emp1",
          "job_id": "81efaabd-aff8-4d66-bdf0-50bb369e8b05",
          "job_name": "MANAGER",
          "total_forms": 78,
          "submitted_forms": 19,
          "submission_percentage": 24,
          "reviewed_forms": 7,
          "review_percentage": 8
        }
      ]
    }
  ]
}