get
https://api.zenoti.com//v1/organizations/treatment_forms/compliance_rule_statistics
This API retrieves all compliance statistics of an organization.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Query Params
| Json Property | Data Type | Description |
|---|---|---|
| centers | List<Guid> | Center IDs to filter by |
| jobs | List<Guid> | Job IDs to filter by |
| employee_ids | List<Guid> | Provider IDs to filter by |
| start_date | DateTime | Start date for statistics (optional) |
| end_date | DateTime | End date for statistics (optional) |
| page | int | Page number for pagination (1-based) |
| limit | int | Number of items per page |
Response Model
(ComplianceStatisticsResponse)
| Json Property | Data Type | Description |
|---|---|---|
| compliance_rule_statistics | List<ComplianceRuleStatistics> | List of rule statistics |
| error | APIV2ErrorModel | Error information |
compliance_rule_statistics object (ComplianceRuleStatistics)
| Json Property | Data Type | Description |
|---|---|---|
| compliance_rule_id | int | Rule ID |
| organization_id | Guid | Organization ID |
| center_id | Guid | Center ID |
| center_name | string | Center name |
| state | string | State |
| jobs | List<JobInfo> | Jobs associated to the rule |
| target_percentage | int | Target percentage for compliance |
| total_forms | int | Total number of forms |
| submitted_forms | int | Number of submitted forms |
| submission_percentage | int | Percentage of forms submitted |
| reviewed_forms | int | Number of reviewed forms |
| review_percentage | int | Percentage of forms reviewed |
| is_compliant | bool | Whether the rule is compliant |
| employee_statistics | List<RuleEmployeeStatistics> | Employee statistics for this rule |
employee_statistics object (RuleEmployeeStatistics)
| Json Property | Data Type | Description |
|---|---|---|
| employee_id | Guid | Employee ID |
| name | string | Provider name |
| job_id | Guid | Job ID |
| job_name | string | Job name |
| total_forms | int | Total number of forms |
| submitted_forms | int | Number of submitted forms |
| submission_percentage | int | Percentage of forms submitted |
| reviewed_forms | int | Number of reviewed forms |
| review_percentage | int | Percentage of forms reviewed |
| is_compliant | bool | Whether the employee is compliant |
jobs object (JobInfo)
| Json Property | Data Type | Description |
|---|---|---|
| id | Guid | Job ID |
| name | string | Job name |