The Assure Customer API (a secure RESTful API that provides programmatic integration capability to Assure) can be used to automate the processes of managing Incident Analysis records in Assure (statistical records used to track safety performance metrics such as hours worked, employee headcount, and calculated frequency rates per Organisational Unit and time period). The primary use case is integrating Assure with an HR or payroll system to automatically push monthly hours worked and employee count figures, keeping frequency rates accurate and up to date without manual data entry. Supported operations are: create, update, and delete. The API must be enabled by Evotix before use and requires technical expertise to implement.
Prerequisites
Before using the Customer API to manage Incident Analysis records, confirm the following are in place:
- API access is enabled - The Customer API functionality must be activated by the Evotix Support Team. Contact your Customer Development Manager (CDM) or Customer Success Manager (CSM) to request access.
- API authentication keys are generated - API keys must be created and managed in Assure before making any API requests. Refer to the API Key Management article for instructions: Creating and managing your API keys
- Incident Analysis record references are known - The reference field cannot be auto-assigned or changed via the API. Every create or update request must include a valid, manually supplied reference. For updates, a record with the matching reference must already exist in Assure.
- Caption Maintenance has been reviewed - Any fields configured as mandatory in Incident Analysis Caption Maintenance must be included in API requests, or the request will fail.
- Technical resource is available - The Customer API requires a level of technical expertise to configure and operate. Implementation is typically handled by a company's IT function.
Overview
The Assure Customer API can be used to automate the processes of managing Incident Analysis records in Assure. The API is accessed via the internet as a secure RESTful API, which is widely supported by integration platforms, ETL (Extract, Transform, Load) tools, and all programming and scripting languages, so it can be easily set up to integrate with external systems. Making use of the Customer API requires a level of technical expertise, so this is typically something that a company's IT function would handle.
Important: The API functionality must be enabled by the Evotix Support Team before you can use it. Please contact your CDM (Customer Development Manager) or CSM (Customer Success Manager) should you be interested in procuring this feature.
Why Use the Incident Analysis API?
Incident Analysis records in Assure store the data that underpins safety performance metrics, including hours worked and number of employees, which are used to calculate rates such as Injury Frequency Rate, Incident Rate, and Incidence Rate.
Manually entering this data each month is time-consuming and introduces the risk of human error, particularly for organisations operating across multiple Organisational Units or sites. The Customer API allows this data to be populated automatically from external systems.
Primary Use Case: Automating Hours Worked and Employee Count from HR or Payroll Systems
The most common integration scenario is connecting Assure to an HR or payroll system to automatically push monthly figures into Incident Analysis records. This typically involves:
- Hours Worked (No. of Man Hours Worked) - extracted from payroll or time and attendance systems and written to the corresponding Incident Analysis record for each Organisational Unit and month.
- Number of Employees - extracted from HR systems and written alongside the hours worked figure.
Once these fields are populated, Assure can automatically calculate safety frequency rates such as Injury Frequency Rate and Incident Rate without manual intervention, ensuring figures are current, consistent, and accurate across the organisation.
Benefits
- Removes manual data entry - monthly hours and headcount figures flow directly from the source of truth rather than being keyed in by hand.
- Improves accuracy - figures match payroll and HR records exactly, eliminating transcription errors.
- Enables timely reporting - frequency rates are always up to date because the underlying data is refreshed automatically each period.
- Scales across the organisation - the API can create or update records for every Organisational Unit simultaneously, making it practical for large or multi-site organisations.
- Supports regulatory reporting - accurate, automated frequency rate data supports compliance reporting requirements such as OSHA 300A submissions.
How Does It Work?
With the Customer API you can:
- Create new Incident Analysis records
- Update existing Incident Analysis records
- Delete Incident Analysis records
Each of these operations requires you to make a request to the Customer API. A detailed user guide and supporting API schema is available, detailing the API methods and the information required to use them.
What Details Must Be Provided?
Minimum Required Fields
The following fields are mandatory in every API request:
- Org Unit - the Organisational Unit (Org Unit) the record belongs to
- Reference - the unique reference for the Incident Analysis record (must be supplied manually; cannot be auto-assigned)
- Data Interval - the defined interval for the analysis period
- Analysis Month - the month the analysis applies to
- Analysis Year - the year the analysis applies to
- No. of Man Hours Worked - the total man hours worked during the analysis period
- Any other fields configured as mandatory via Incident Analysis Caption Maintenance
Optional Fields (Defaulted If Not Supplied)
The following fields can be set and will be defaulted if not supplied:
- Locality
- Specify Interval
- From Date
- To Date
- Number of Employees
- Lifetime Hours
- Cascade Results
- Supply Analysis
- OSHA 300A Reference
- Total Lost Accidents
- Total Reportable Accidents
- Total Accidents
- Injury Frequency Rate
- Incident Rate
- Incidence Rate
Out of Scope
The following elements are currently out of scope or subject to restrictions:
- The Incident Analysis reference field cannot be changed via the API. You can only create new records with a unique reference, or update records where an existing record for the reference provided already exists.
- The Incident Analysis reference field cannot be automatically assigned by the system when creating or updating records. The reference must be provided in every request.
- Supporting items cannot be added via the API. This includes Actions, attachments, notes, reviews, and links to policies and guidance. If default reviewers and approvers are configured, they will be automatically applied on record creation.
- Any default values set within Caption Maintenance are not taken into consideration by the API.
- Only the 'Select' option is available via the API when the module reference for either an Incident Record or a Vehicle Incident record is provided. The API cannot be used with the 'Select and Copy' or 'Create' options for those linked records.
Setting Up the API
Follow these steps in order to configure the Incident Analysis API.
Step 1: Request Access
Before you can get started, you need to request access from Evotix through your Customer Development Manager or Customer Success Manager.
Step 2: Create and Manage API Authentication Keys
You can create and manage your API authentication keys at any time in Assure. Full instructions are available in the API Key Management article: Creating and managing your API keys
Step 3: Configure the Customer API (Getting Started)
Set up the Customer API by accessing the user guide: Assure Customer API User Guide -- Getting Started Download the Getting Started Guide
Step 4: Configure the Incident Analysis API
Set up the Incident Analysis API by accessing the user guide: Customer API User Guide -- Incident Analysis API Download the Incident Analysis API Guide
AI Metadata
Product Area: Customer API Management, Incident Management
User Role: IT Administrator / Integration Engineer (technical implementation); System Administrator (access request)
Tags: Customer API, Incident Analysis, create Incident Analysis, update Incident Analysis, delete Incident Analysis, RESTful API, integration, automation, ETL, incident statistics, man hours, OSHA, accident rates Version/Region: All Assure versions; all regions
Important Synonyms: Incident Analysis = Incident Analysis record = incident stats record; Customer API = Assure Customer API = RESTful API; CDM = Customer Development Manager; CSM = Customer Success Manager; Caption Maintenance = field configuration; Man Hours = hours worked; OSHA 300A = OSHA reporting reference
Suggested Embedding Keywords: Incident Analysis API, create incident analysis record API, update incident analysis Assure, delete incident analysis API, Assure Customer API incident, man hours worked API, OSHA 300A reference API, data interval API, automate incident analysis, accident rate API, injury frequency rate API
Relevant Modules and Cross-Module Implications: This article sits within the Customer API Management area of Assure. The Incident Analysis module is a submodule of the Incident area in Assure, used to track statistical safety metrics such as hours worked, accident rates, and injury frequency across Organisational Units. When linking an Incident Analysis record to an existing Incident Record or Vehicle Incident record via the API, only the Select option is available. The API cannot be used with the Select and Copy or Create options for those linked records. Caption Maintenance settings for the Incident Analysis module may introduce additional mandatory fields that must be accounted for in API requests.