Retrieve compliance statistics

This API retrieves all compliance statistics of an organization.

Query Params

Json PropertyData TypeDescription
centersList<Guid>Center IDs to filter by
jobsList<Guid>Job IDs to filter by
employee_idsList<Guid>Provider IDs to filter by
start_dateDateTimeStart date for statistics (optional)
end_dateDateTimeEnd date for statistics (optional)
pageintPage number for pagination (1-based)
limitintNumber of items per page

Response Model

(ComplianceStatisticsResponse)

Json PropertyData TypeDescription
compliance_rule_statisticsList<ComplianceRuleStatistics>List of rule statistics
errorAPIV2ErrorModelError information

compliance_rule_statistics object (ComplianceRuleStatistics)

Json PropertyData TypeDescription
compliance_rule_idintRule ID
organization_idGuidOrganization ID
center_idGuidCenter ID
center_namestringCenter name
statestringState
jobsList<JobInfo>Jobs associated to the rule
target_percentageintTarget percentage for compliance
total_formsintTotal number of forms
submitted_formsintNumber of submitted forms
submission_percentageintPercentage of forms submitted
reviewed_formsintNumber of reviewed forms
review_percentageintPercentage of forms reviewed
is_compliantboolWhether the rule is compliant
employee_statisticsList<RuleEmployeeStatistics>Employee statistics for this rule

employee_statistics object (RuleEmployeeStatistics)

Json PropertyData TypeDescription
employee_idGuidEmployee ID
namestringProvider name
job_idGuidJob ID
job_namestringJob name
total_formsintTotal number of forms
submitted_formsintNumber of submitted forms
submission_percentageintPercentage of forms submitted
reviewed_formsintNumber of reviewed forms
review_percentageintPercentage of forms reviewed
is_compliantboolWhether the employee is compliant

jobs object (JobInfo)

Json PropertyData TypeDescription
idGuidJob ID
namestringJob name
Language
Credentials
Header
Click Try It! to start a request and see the response here!