# Audit Record

The Audit object provides a detailed record of a specific event that occurred within the platform. 

This object contains the following attributes:

<table><thead><tr><th width="144">Field Name</th><th width="231">Data Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>string</td><td><p>A unique identifier for the audit record. Note that no nesting exists for this identifier.</p><p>Example: AUD-1671-0642-1234-1234</p></td></tr><tr><td><code>event</code></td><td>string</td><td><p>The event code. Format: {platform/extension}.{module/extension name}.{object}.{action}</p><p>Example: platform.commerce.order.created</p></td></tr><tr><td><code>summary</code></td><td>string</td><td><p>A summary of the audit record.</p><p>Example: Order created</p></td></tr><tr><td><code>details</code></td><td>string</td><td><p>The audit details template. Any document property may be used as a placeholder.</p><p>Example: The order {{order.id}} has been successfully created by {{actor.name}} and is now in the platform.</p></td></tr><tr><td><code>actor</code></td><td>object (<a href="#auditrecordactor">auditRecordActor</a>)</td><td><p>Information about the actor who has triggered an event.</p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">{
  "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",
  }
}
</code></pre></td></tr><tr><td><code>object</code></td><td>object (<a href="#heading-title-text-1">auditRecord</a>)</td><td><p>The API object for which an event has been triggered.</p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">{
  "id": "ORD-3568-4038-2535",
  "type": "order",
  "icon": null,
  "objectType" : "Order"
}
</code></pre></td></tr><tr><td><code>timestamp</code></td><td>dateTime</td><td><p>The timestamp of the event.</p><p>Example: 2024-07-25T09:09:30.087Z</p></td></tr><tr><td><code>type</code></td><td>enum</td><td>The visibility of the audit record. Allowed values:  <code>public</code> or <code>private</code>.</td></tr><tr><td><code>request</code></td><td>object (<a href="#audit-record-request">auditRecordRequest</a>)</td><td><p>The request for technical data.</p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">{
  "api": {
    "ip": "192.168.2.2",
    "geolocation": {
       "countryCode": "ES",
       "countryName": "Spain",
       "region": "Catalonia"
    },
    "userAgent": "Chrome" 
  }
  "worker": {
    "workerName": null }
  "log": {
    "correlationId": "some-app-insights-id" }
}
</code></pre></td></tr><tr><td><code>documents</code></td><td>object (<a href="#heading-title-text-2">auditRecordDocuments</a>)</td><td><p>A <code>JSON</code> element containing a collection of linked <code>eventRecord</code> objects.</p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">{
    "order_01": {
    "id": "ORD-3568-4038-2535",
    "type": "Purchase",
    "status": "Completed" 
  }
  "extraData_01" {
    "extra_prop_01": "Some value that does not exist in order" 
  }
}
</code></pre></td></tr><tr><td><code>viewers</code></td><td>object (<a href="#heading-title-text-1">auditRecordViewer</a>)</td><td><p>The list of accounts that have access to the audit records.</p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">[
  {
      "id": "ACC-3408-7241",
      "name": "MPT 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"
  }
]
</code></pre></td></tr></tbody></table>

## Audit Event Type object <a href="#heading-title-text" id="heading-title-text"></a>

Audit Event Type refers to an event that has occurred within the platform. These records are generated automatically and can be used to store supplementary information related to the specific event type.

<table><thead><tr><th width="145">Field Name</th><th width="140">Data Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>string</td><td><p>The ID of the item. </p><p>Example: AET-7149-2212</p></td></tr><tr><td><code>key</code></td><td>string</td><td><p>The event's key. </p><p>Example: AET-7149-2212</p></td></tr><tr><td><code>name</code></td><td>string</td><td><p>The name of the event. </p><p>Example: Order created</p></td></tr><tr><td><code>description</code></td><td>string</td><td><p>A description of the event. </p><p>Example: A standard event that occurs upon the creation of an order.</p></td></tr></tbody></table>

### Example response <a href="#heading-title-text" id="heading-title-text"></a>

{% code lineNumbers="true" %}

```json
{
  "id": "AET-5699-2751",
  "Key": "platform.commerce.order.created",
  "Name": "Order created.",
  "Description": "A standard event that occurs upon the creation of an order."
},
```

{% endcode %}

## Audit Record object <a href="#heading-title-text" id="heading-title-text"></a>

The Audit record object signifies a specific entity within the platform for which an Audit object is generated. It is important to note that each Audit object can only be created for one platform object at a time.

<table><thead><tr><th width="143">Field Name</th><th width="149">Data Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>string</td><td><p>The object's identifier. </p><p>Example: ORD-1234-1234-5678</p></td></tr><tr><td><code>name</code></td><td>string</td><td><p>The name of the platform object. Contains the ID if the name doesn't exist. </p><p>Example: ORD-1234-1234-5678</p></td></tr><tr><td><code>icon</code></td><td>string</td><td>The URL of the object icon. </td></tr><tr><td><code>objectType</code></td><td>string</td><td><p>The type of object. </p><p>Example: Order</p></td></tr><tr><td><code>revision</code></td><td>integer</td><td><p>The revision of the object. </p><p>Example: 24</p></td></tr></tbody></table>

### Example response

{% code lineNumbers="true" %}

```json
{
    "event": "platform.commerce.order.created",
    "summary": "Order Created",
    "details": "The order ORD-1208-2301-8479 has been successfully created by Jane Doe 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": "JANE DOE",
        "icon": "/v1/accounts/users/USR-0556-8733/icon",
        "account": {
            "id": "ACC-3408-7241",
            "name": "MPT_QA Commerce e2e client",
            "icon": "/v1/accounts/accounts/ACC-3408-7241/icon",
            "accountType": "Client"
        }
    },
    "type": "Public",
    "request": {
        "api": {
            "ip": "00.00.00.00",
            "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": "Jane Doe",
            "icon": "/v1/accounts/users/USR-0556-8733/icon",
            "account": {
                "id": "ACC-3408-7241",
                "name": "MPT_QA Commerce e2e client",
                "icon": "/v1/accounts/accounts/ACC-3408-7241/icon",
                "accountType": "Client"
            }
        }
    },
    "viewers": [
        {
            "id": "ACC-3408-7241",
            "name": "MPT_QA 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"
}
```

{% endcode %}

## Audit Record Actor object

The Identity object signifies a user present within the platform, which is associated with the creation of an Audit object.

<table><thead><tr><th width="157">Field Name</th><th width="236">Data Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>string</td><td><p>The ID of the user. </p><p>Example: USR-0556-8733</p></td></tr><tr><td><code>name</code></td><td>string</td><td><p>The name of the user. </p><p>Example: John Doe</p></td></tr><tr><td><code>icon</code></td><td>string</td><td><p>The URL to the user's logo. </p><p>Example: /v1/accounts/users/USR-0556-8733/icon</p></td></tr><tr><td><code>account</code></td><td>object (<a href="#audit-record-actor-account">auditRecordActorAccount</a>)</td><td><p>The user's account details.  </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">{
    "id": "ACC-3408-7241",
    "name": "MPT_QA_STATIC Commerce e2e client",
    "icon": "/v1/accounts/accounts/ACC-3408-7241/icon",
    "accountType": "Client"
  }
</code></pre></td></tr></tbody></table>

### Example response <a href="#audit-record-request" id="audit-record-request"></a>

{% code lineNumbers="true" %}

```json
 "name": "JOHN DOE",
  "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"
  }
} 
```

{% endcode %}

## Audit Record Actor Account object <a href="#audit-record-actor-account" id="audit-record-actor-account"></a>

<table><thead><tr><th width="139">Field Name</th><th width="148">Data Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>string</td><td><p>The ID of the account.</p><p>Example: ACC-3408-7241</p></td></tr><tr><td><code>name</code></td><td>string</td><td><p>The name of the account. </p><p>Example: MPT Commerce e2e client</p></td></tr><tr><td><code>icon</code></td><td>string</td><td><p>The URL to the account's logo. </p><p>Example: /v1/accounts/accounts/ACC-3408-7241/icon</p></td></tr><tr><td><code>accountType</code></td><td>object</td><td><p>The type of <a href="../accounts-api/account">account</a>.</p><p>Example: Client</p></td></tr></tbody></table>

### Example response <a href="#audit-record-request" id="audit-record-request"></a>

{% code lineNumbers="true" %}

```json
{
    "id": "ACC-3408-7241",
    "name": "MPT Commerce e2e client",
    "icon": "/v1/accounts/accounts/ACC-3408-7241/icon",
    "accountType": "Client"
  }
```

{% endcode %}

## Audit Record Request object <a href="#audit-record-request" id="audit-record-request"></a>

The Request object captures request data that is useful to store as part of the Audit entry.

<table><thead><tr><th width="120">Field Name</th><th width="160">Data Type</th><th>Description</th></tr></thead><tbody><tr><td><code>api</code></td><td>object (<a href="#api-request">apiRequest</a>)</td><td><p>The details of the API request. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">{
    "ip": "108.141.111.208",
    "geolocation": {
        "countryCode": "NL",
        "countryName": "Netherlands",
        "region": "North Holland"
    },
    "userAgent": "swo-extensions/1.0"
}
</code></pre></td></tr><tr><td><code>worker</code></td><td>object (<a href="#workerrequest">workerRequest</a>)</td><td><p>The worker request details. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">{
    "workerName": "platformWorker"
}
</code></pre></td></tr><tr><td><code>log</code></td><td>object (<a href="#log-info">logInfo</a>)</td><td><p>The logging information or metadata. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">{
    "correlationId": "1233213215468"
}
</code></pre></td></tr></tbody></table>

### API Request object <a href="#api-request" id="api-request"></a>

This object captures metadata related to web-based requests, which is useful to include in the audit entry. It is populated only when the request is a web request.

<table><thead><tr><th width="152">Field Name</th><th width="143">Data Type</th><th>Description</th></tr></thead><tbody><tr><td><code>ip</code></td><td>string</td><td><p>A unique identifier representing the IP address.</p><p>Example: 192.168.2.2</p></td></tr><tr><td><code>userAgent</code></td><td>string</td><td><p>Identifies the user agent making the API request.</p><p>Example: Chrome</p></td></tr><tr><td><code>geolocation</code></td><td>object</td><td><p>Geolocation metadata associated with the request.</p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">{
  "countryCode": "NL",
  "countryName": "Netherlands",
  "region": "North Holland"
}
</code></pre></td></tr></tbody></table>

### Worker Request object

This object captures metadata related to the request worker, which is useful to store as part of the Audit entry. It is populated only when the request is a worker request.

<table><thead><tr><th width="149">Field Name</th><th width="141">Data Type</th><th>Description</th></tr></thead><tbody><tr><td><code>workerName</code></td><td>string</td><td><p>The name of the request worker. </p><p>Example: worker-1234</p></td></tr></tbody></table>

### Log Info object <a href="#log-info" id="log-info"></a>

This object captures request log metadata that is useful to include in the audit entry.

<table><thead><tr><th width="154">Field Name</th><th width="136">Data Type</th><th>Description</th></tr></thead><tbody><tr><td><code>corellationId</code></td><td>string</td><td><p>The ID that can be used to track requests in the logging system.</p><p>Example: 654681135168546</p></td></tr></tbody></table>

## Audit Record Documents object <a href="#heading-title-text" id="heading-title-text"></a>

The Documents object is a flexible JSON structure designed to hold essential information that characterizes an event. It can represent either a complete or partial depiction of the object related to the audit event, or it may consist of any arbitrary JSON data.

{% code overflow="wrap" lineNumbers="true" %}

```json
{
  "order": {
      "id": "ORD-1208-2301-8479",
      "href": "/commerce/orders/ORD-1208-2301-8479",
      "type": "Termination",
      "status": "Processing"
  },
  "actor": {
      "id": "TKN-8033-2484",
      "name": "Adobe Extension API",
      "icon": "",
      "account": {
          "id": "ACC-1675-9721",
          "name": "Adobe",
          "icon": "/v1/accounts/accounts/ACC-1675-9721/icon",
          "accountType": "Vendor"
      }
  }
}
```

{% endcode %}

## Audit Record Viewer object <a href="#heading-title-text" id="heading-title-text"></a>

The audit record viewer object signifies a platform account that grants access to specific audit records for its members.

<table><thead><tr><th width="139">Field Name</th><th width="148">Data Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>string</td><td><p>The ID of the account.</p><p>Example: ACC-3408-7241</p></td></tr><tr><td><code>name</code></td><td>string</td><td><p>The name of the account. </p><p>Example: MPT Commerce e2e client</p></td></tr><tr><td><code>icon</code></td><td>string</td><td><p>The URL to the account's logo. </p><p>Example: /v1/accounts/accounts/ACC-3408-7241/icon</p></td></tr><tr><td><code>accountType</code></td><td>object</td><td><p>The type of <a href="../accounts-api/account">account</a>.</p><p>Example: Client</p></td></tr></tbody></table>

### Example response

{% code lineNumbers="true" %}

```json
{
  "id": "ACC-3408-7241",
  "name": "MPT_QA_STATIC Commerce e2e client",
  "type": "Client",
  "icon": "/v1/accounts/accounts/ACC-3408-7241/icon"
}
```

{% endcode %}