Setting up your API Data Extraction requirements
In addition to creating API keys, data extraction setting will have to be enabled in Assure. This define the format and frequency for creating the data extraction file, as well as what data is included.
PLEASE NOTE: Evotix will do the set-up for data extraction management for you. Please contact your CDM (Customer Development Manager) or CSM (Customer Success Manager) should you be interested in procuring this feature.
You are able to view your current set up in System Setting > Data Extraction Management.
As a default you will be able to see the set up as below. No Modules are selected which means that data will not yet be returned until this is set up by Evotix.
To set-up the Data Extract go to System Settings of Assure (This action will be done by Evotix Administrators – contact your CSM)
Check out the details about the available settings below.
Settings > System Configuration > System Settings > Data Extract Management
Here the Evotix team will define various elements of your data extraction.
Format
The format of the Data Extract can be selected to be either JSON (recommended) or CSV
Frequency
Frequency of the extract is the following:
- ALL Data extracts are generated daily. Each extract is retrieved once per day and includes all data up to the end of the previous day.
- Additionally, extracts can be configured for hourly extracts by selecting the corresponding checkbox.
- Hourly extracts are generated every hour and include all newly created or modified data from the last daily extract up to the previous hour.
Available Extracts
This list of modules available for data extraction will expand as further modules are released, any modules that have been made available will be shown in the list. More modules can be added by clicking the ‘Add’ button then selecting from the available list.
All Assure record fields will be included in each data extract. To ensure a standard data structured that is not impacted by configuration changes to caption, the columns fields will show Assure’s default captions, not customer configured captions.
The field mapping button will allow you to download a CSV to support the mapping of Assure default field captions to Customer configured captions. The columns in the CSV file show the Assure Field Captions, and the Data Extract fields so that these can be cross-referenced from the external tool.
The modules that are extracted can also be removed by clicking the ‘Remove’ button on the table.
Configuring iQ template questions for export
Note: iQ template data can be included in your data export. You can define for each question if this should be included in the data export.
To be included in the export, the IQ template question needs a Data Extract field export code to be set. This field is available in the Configure Response option for each iQ questions. This must be set on each IQ question or it will not be included. Please ensure that a standard naming convention is used to make it easy for you to use this data in further analysis.
The value of the ‘data extraction field’ must:
- Be alphanumeric
- Start with a letter (not a number)
- Be 30 characters or less