Data export API
Qarma supports file-based data export for further analysis outside Qarma. This is useful for:
Business Intelligence applications showing dashboards, deep analysis of inspection data and supplier scorecards
Bulk updating order status in ERP systems (this can also be accomplished using the event-based API)
Updating order booking systems with status and dates for inspections
Update master data systems with information on suppliers and production units
Of course, there are many other applications. Overall, the API supports defining data export runs which will be running at scheduled intervals, delivering files that can then readily be downloaded through a URL which includes an API key.
Getting access
You can access the data manually or programmatically. To extract data manually, please go to the Data export page and you will be able to make a one-time extract of the data.
To get an API key and URL for continuous integration of the data, please contact Qarma Support, noting the parameters you would like to base the export data on.
Parameters
The parameters are:
Name | Description |
|---|---|
Date start and Date end | The start date can be a specific date or a relative date (for example The date filter will be based on dates according to their status:
Please note that since Qarma supports off-line operations, there can be a delay between the actual end date as measured on the mobile device and the time the data is available at Qarma’s server. This means if you filter for a daily extract of data, it needs to include data several days back to be sure all data is included. |
Type | Inspections, Audits or Suppliers |
Extra data | The basic data that is always exported is a list of inspections, audits or suppliers, depending on type. In addition, the following data can be included:
Only include checkpoints and defects/corrective actions if they are used, since they will contribute significantly to the size of the export file. |
Status | Select one or more statuses:
|
Interval | Define how often the export job should run. This is quite flexible, so you can decide every day at 20:00, every Monday at 06:00, etc |
Data format
Data is served as both Excel and a set of CSV files. The content is the same. The Excel file will contain one or more sheets, depending on the Extra data parameter defined above. For each sheet, there is a corresponding CSV file.
Due to limitation on the number of rows in Excel files, we recommend large file integrations to be based on CSV files rather than Excel files. If Qarma exports data with more than one million rows, no Excel file is generated, and only CSV files will be available.