Audit Record

The Audit Record object provides a detailed record of a specific event that occurred within the platform. This object contains the following properties:

Field	Type	Description
id	string	A unique identifier for the audit record. Note that no nesting exists for this identifier. Example: AUD-1671-0642-1234-1234
event	string	The event code. Format: {platform/extension}.{module/extension name}.{object}.{action} Example: platform.commerce.order.created
summary	string	A summary of the audit record. Example: Order created
details	string	The audit details template. Any document property may be used as a placeholder. Example: The order {{order.id}} has been successfully created by {{actor.name}} and is now in the platform.
actor	auditrecord Actor	Information about the actor who has triggered an event. Example: { "id": "USR-2311-4038", "name": "Will Smith", "icon": "/public/users/usr-2311-4038.jpg", "account": { "id": "ACC-8989-32321", "name": "AdAstra Flex", "icon": "/public/accounts/acc-8989-32321.jpg", } }
object	auditrecord Object	The API object for which an event has been triggered. Example: { "id": "ORD-3568-4038-2535", "type": "order", "icon": null, "objectType" : "Order" }
timestamp	dateTime	The timestamp of the event. Example: 2024-07-25T09:09:30.087Z
type	auditRecordType Enum	The visibility of the audit record. Possible values: Public or Private.
request	request	The request for technical data. Example: { "api": { "ip": "192.168.2.2", "geolocation": { "countryCode": "ES", "countryName": "Spain", "region": "Catalonia" }, "userAgent": "Chrome" } "worker": { "workerName": null } "log": { "correlationId": "some-app-insights-id" } }: null,
documents	object	A JSON element containing a collection of linked Event Record objects. Example: { "order_01": { "id": "ORD-3568-4038-2535", "type": "Purchase", "status": "Completed" } "extraData_01" { "extra_prop_01": "Some value that does not exist in order" } }
viewers	viewer	A list of accounts that have access to the audit records. Example: [ { "id": "ACC-3408-7241", "name": "MPT_QA_STATIC Commerce e2e client", "type": "Client", "icon": "/v1/accounts/accounts/ACC-3408-7241/icon" }, { "id": "ACC-1675-9721", "name": "Adobe", "type": "Vendor", "icon": "/v1/accounts/accounts/ACC-1675-9721/icon" } ]

Example

AUDIT RECORD OBJECT

{
    "event": "platform.commerce.order.created",
    "summary": "Order Created",
    "details": "The order ORD-1208-2301-8479 has been successfully created by Balint Polgar and is now in the platform.",
    "object": {
        "id": "ORD-1208-2301-8479",
        "name": "ORD-1208-2301-8479",
        "objectType": "Order"
    },
    "timestamp": "2024-10-21T10:03:00.800Z",
    "actor": {
        "id": "USR-0556-8733",
        "name": "Balint Polgar",
        "icon": "/v1/accounts/users/USR-0556-8733/icon",
        "account": {
            "id": "ACC-3408-7241",
            "name": "MPT_QA_STATIC Commerce e2e client",
            "icon": "/v1/accounts/accounts/ACC-3408-7241/icon",
            "accountType": "Client"
        }
    },
    "type": "Public",
    "request": {
        "api": {
            "ip": "92.26.0.92",
            "geolocation": {
                "countryCode": "GB",
                "countryName": "United Kingdom",
                "region": "Scotland"
            },
            "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:131.0) Gecko/20100101 Firefox/131.0"
        }
    },
    "documents": {
        "order": {
            "id": "ORD-1208-2301-8479",
            "type": "Termination",
            "status": "Draft"
        },
        "actor": {
            "id": "USR-0556-8733",
            "name": "Balint Polgar",
            "icon": "/v1/accounts/users/USR-0556-8733/icon",
            "account": {
                "id": "ACC-3408-7241",
                "name": "MPT_QA_STATIC Commerce e2e client",
                "icon": "/v1/accounts/accounts/ACC-3408-7241/icon",
                "accountType": "Client"
            }
        }
    },
    "viewers": [
        {
            "id": "ACC-3408-7241",
            "name": "MPT_QA_STATIC Commerce e2e client",
            "type": "Client",
            "icon": "/v1/accounts/accounts/ACC-3408-7241/icon"
        },
        {
            "id": "ACC-1675-9721",
            "name": "Adobe",
            "type": "Vendor",
            "icon": "/v1/accounts/accounts/ACC-1675-9721/icon"
        }
    ],
    "id": "AUD-0391-8050-9033-9920"
}