Audit Data
The audit API gives you insight into how the system is being used
To use these functions you will need "admin" privilege
Methods
| Service | Format | Description | Version | Example |
|---|---|---|---|---|
| /api/v1/audit | JSON | Get a list of services to retrieve audit data | 15.12+ | https://sg.smap.com.au/api/v1/audit |
| /api/v1/audit/{survey ident} | GeoJSON | Get per question audit data from a survey. {survey ident} is the survey ident which can be found in the list of services retrieved above. A GeoJson object is returned for each question and includes the time it took for the data collector to answer the question and the gps coordinates of where the question was answered. This data is only returned if "Timing Data" and "Record Location" were enabled for the survey. | 15.12+ | https://sg.smap.com.au/api/v1/audit/s1190_16030 |
Parameters
| Parameter | Description | Version | Example |
|---|---|---|---|
| start | Retrieve data from the specified primary key | 15.12+ | https://sg.smap.com.au/api/v1/data.csv?start=2 |
| limit | The number of records to retrieve | 15.12+ | https://sg.smap.com.au/api/v1/data.csv?start=2&limit=1 |
Original Audit log File
Download the audit file that contains the original audit data before it is processed by the server
Methods
| Service | Format | Description | Version | Example |
|---|---|---|---|---|
| /api/v1/audit/log/{survey ident}/{key} | JSON | Survey Ident is the identifier for the survey. Key is the identifier for the instance. The file is in CSV format. This the only way you can get access to the list of changes to individual questions. | 19.07+ | https://sg.smap.com.au/api/v1/audit/log/s193_1778/uuid:9fcf9bf7-d780-4397-8781-b4ba0bbe0cb8 |