Audit Trails

Get the audit trail for a document

Returns a list of audit trail entries for a specific document.
GET /audit_trail/<document_key>
Returns a list of audit_trail entries for a document.

Optional query string parameters:

page_size (indicates how many records to return). 100 by default
cursor (if you received a cursor from request
obfuscate_contact_info (boolean). Obfuscates/masks email addresses and mobile numbers.

Properties

audit_detail is what actually happened
audit_detail_formatted includes the date (in the default timezone) and the audit_entry type.
audit_entry_type is the type of audit_trail event. See Audit entry types
date_created is date when the audit occurred. It's a number representing ticks since the epoch.
document_key is the document for which this audit_trail applies
email_address is the email address that applies to the audit trail entry.
ip_address is the ip_address from where the request originated. E.g. the user's computer or a server (in the case of email_delivery reports).
key is the audit trail entry key.
mobile_number: the mobile_number of the user for which the audit trail applies.
user_key: the user_key of the user who is performing the action.
user_name: the name of the user performing the action

Example response

{
    "data": {
        "audit_trail": [
            {
                "audit_detail": "[email protected] received and opened email",
                "audit_detail_formatted": "2017-08-14 12:45:13 SAST+0200 email_tracking_info:    [email protected] received and opened email    66.249.93.11",
                "audit_entry_type": "email_tracking_info",
                "date_created": 1502707513000,
                "document_key": "ahFzfnF1aWNrbHlzaWduLWRldnIkCxIIRG9jdW1lbnQiFkhBUlF6eG5hbExtSjdWd1RhWjJNeWwM",
                "email_address": "[email protected]",
                "ip_address": "66.249.93.11",
                "key": "ahFzfnF1aWNrbHlzaWduLWRldnI9CxIKQXVkaXRUcmFpbCIWSEFSUXp4bmFsTG1KN1Z3VGFaMk15bAwLEgpBdWRpdFRyYWlsGICAgICgxI4KDA",
                "mobile_number": "",
                "user_key": null,
                "user_name": null
            },
            {
                "audit_detail": "[email protected] received and opened email",
                "audit_detail_formatted": "2017-08-14 12:45:13 SAST+0200 email_tracking_info:    [email protected] received and opened email    66.249.93.3",
                "audit_entry_type": "email_tracking_info",
                "date_created": 1502707513000,
                "document_key": "ahFzfnF1aWNrbHlzaWduLWRldnIkCxIIRG9jdW1lbnQiFkhBUlF6eG5hbExtSjdWd1RhWjJNeWwM",
                "email_address": "[email protected]",
                "ip_address": "66.249.93.3",
                "key": "ahFzfnF1aWNrbHlzaWduLWRldnI9CxIKQXVkaXRUcmFpbCIWSEFSUXp4bmFsTG1KN1Z3VGFaMk15bAwLEgpBdWRpdFRyYWlsGICAgICgkp8KDA",
                "mobile_number": "",
                "user_key": null,
                "user_name": null
            }
          
        ]
    },
    "status": {
        "status_code": 200
    }
}