> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/audit.md).

# Audit

Query the audit trail to retrieve a paginated, filterable log of entity create, update, and delete events across your workspace.

Audit trail of the changes to the entities of your workspace.

## Queries

### auditEvents

Lists audit events in the caller's workspace.

```graphql
auditEvents(
    filter: AuditEventFilter
    first: Int
    after: String
    last: Int
    before: String
    orderBy: AuditEventOrder = { field: OCCURRED_AT, direction: DESC }
  ): AuditEventConnection!
```

**Arguments**

| Name      | Type               | Description                                                                                   |
| --------- | ------------------ | --------------------------------------------------------------------------------------------- |
| `filter`  | `AuditEventFilter` | Filtering options for the returned audit events.                                              |
| `first`   | `Int`              | The first `n` elements from the [paginated list](/docs/navixy-graphql-api/pagination.md).     |
| `after`   | `String`           | The elements that come after the specified [cursor](/docs/navixy-graphql-api/pagination.md).  |
| `last`    | `Int`              | The last `n` elements from the [paginated list](/docs/navixy-graphql-api/pagination.md).      |
| `before`  | `String`           | The elements that come before the specified [cursor](/docs/navixy-graphql-api/pagination.md). |
| `orderBy` | `AuditEventOrder`  | The ordering options for the returned audit events.                                           |

**Input types:**

<details>

<summary>AuditEventFilter</summary>

Filtering options for audit events.

| Field            | Type                                                                       | Description                                        |
| ---------------- | -------------------------------------------------------------------------- | -------------------------------------------------- |
| `actorIds`       | `[ID!]`                                                                    | Filter by actors (OR within field).                |
| `aggregateTypes` | \[[Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)!]     | Filter by entity types (OR within field).          |
| `aggregateIds`   | `[ID!]`                                                                    | Filter by specific entity IDs (OR within field).   |
| `eventTypes`     | \[[AuditEventType](#auditeventtype)!]                                      | Filter by event types (OR within field).           |
| `sourceTypes`    | \[[SourceType](#sourcetype)!]                                              | Filter by source types (OR within field).          |
| `traceId`        | `String`                                                                   | Filter by trace ID.                                |
| `from`           | [DateTime](/docs/navixy-graphql-api/core-api-reference/common.md#datetime) | Return events that occurred after this timestamp.  |
| `to`             | [DateTime](/docs/navixy-graphql-api/core-api-reference/common.md#datetime) | Return events that occurred before this timestamp. |

</details>

<details>

<summary>AuditEventOrder</summary>

Ordering options for audit events.

| Field       | Type                                                                                    | Description             |
| ----------- | --------------------------------------------------------------------------------------- | ----------------------- |
| `field`     | [AuditEventOrderField](#auditeventorderfield)!                                          | The field to order by.  |
| `direction` | [OrderDirection](/docs/navixy-graphql-api/core-api-reference/common.md#orderdirection)! | The direction to order. |

</details>

**Output types:**

<details>

<summary>AuditEventConnection</summary>

A paginated list of AuditEvent items.

**Implements:** [Connection](/docs/navixy-graphql-api/core-api-reference/common.md#connection)

| Field      | Type                                                                         | Description                                                |
| ---------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `edges`    | \[[AuditEventEdge](#auditeventedge)!]!                                       | A list of edges.                                           |
| `nodes`    | \[[AuditEvent](#auditevent)!]!                                               | A list of nodes in the connection (without edge metadata). |
| `pageInfo` | [PageInfo](/docs/navixy-graphql-api/core-api-reference/common.md#pageinfo)!  | Information about the current page.                        |
| `total`    | [CountInfo](/docs/navixy-graphql-api/core-api-reference/common.md#countinfo) | The total count of items matching the filter.              |

</details>

***

### entityHistory

Retrieves the change history for any entity in the caller's workspace.

```graphql
entityHistory(
    entityId: ID!
    filter: AuditEventFilter
    first: Int
    after: String
    last: Int
    before: String
    orderBy: AuditEventOrder = { field: OCCURRED_AT, direction: DESC }
  ): AuditEventConnection!
```

**Arguments**

| Name       | Type               | Description                                                                                   |
| ---------- | ------------------ | --------------------------------------------------------------------------------------------- |
| `entityId` | `ID!`              | The ID of the entity to retrieve history for.                                                 |
| `filter`   | `AuditEventFilter` | Filtering options for the returned audit events.                                              |
| `first`    | `Int`              | The first `n` elements from the [paginated list](/docs/navixy-graphql-api/pagination.md).     |
| `after`    | `String`           | The elements that come after the specified [cursor](/docs/navixy-graphql-api/pagination.md).  |
| `last`     | `Int`              | The last `n` elements from the [paginated list](/docs/navixy-graphql-api/pagination.md).      |
| `before`   | `String`           | The elements that come before the specified [cursor](/docs/navixy-graphql-api/pagination.md). |
| `orderBy`  | `AuditEventOrder`  | The ordering options for the returned audit events.                                           |

**Input types:**

<details>

<summary>AuditEventFilter</summary>

Filtering options for audit events.

| Field            | Type                                                                       | Description                                        |
| ---------------- | -------------------------------------------------------------------------- | -------------------------------------------------- |
| `actorIds`       | `[ID!]`                                                                    | Filter by actors (OR within field).                |
| `aggregateTypes` | \[[Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)!]     | Filter by entity types (OR within field).          |
| `aggregateIds`   | `[ID!]`                                                                    | Filter by specific entity IDs (OR within field).   |
| `eventTypes`     | \[[AuditEventType](#auditeventtype)!]                                      | Filter by event types (OR within field).           |
| `sourceTypes`    | \[[SourceType](#sourcetype)!]                                              | Filter by source types (OR within field).          |
| `traceId`        | `String`                                                                   | Filter by trace ID.                                |
| `from`           | [DateTime](/docs/navixy-graphql-api/core-api-reference/common.md#datetime) | Return events that occurred after this timestamp.  |
| `to`             | [DateTime](/docs/navixy-graphql-api/core-api-reference/common.md#datetime) | Return events that occurred before this timestamp. |

</details>

<details>

<summary>AuditEventOrder</summary>

Ordering options for audit events.

| Field       | Type                                                                                    | Description             |
| ----------- | --------------------------------------------------------------------------------------- | ----------------------- |
| `field`     | [AuditEventOrderField](#auditeventorderfield)!                                          | The field to order by.  |
| `direction` | [OrderDirection](/docs/navixy-graphql-api/core-api-reference/common.md#orderdirection)! | The direction to order. |

</details>

**Output types:**

<details>

<summary>AuditEventConnection</summary>

A paginated list of AuditEvent items.

**Implements:** [Connection](/docs/navixy-graphql-api/core-api-reference/common.md#connection)

| Field      | Type                                                                         | Description                                                |
| ---------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `edges`    | \[[AuditEventEdge](#auditeventedge)!]!                                       | A list of edges.                                           |
| `nodes`    | \[[AuditEvent](#auditevent)!]!                                               | A list of nodes in the connection (without edge metadata). |
| `pageInfo` | [PageInfo](/docs/navixy-graphql-api/core-api-reference/common.md#pageinfo)!  | Information about the current page.                        |
| `total`    | [CountInfo](/docs/navixy-graphql-api/core-api-reference/common.md#countinfo) | The total count of items matching the filter.              |

</details>

***

## Objects

### AuditEvent

An audit log entry recording an event that occurred in the system.

**Implements:** [Node](/docs/navixy-graphql-api/core-api-reference/common.md#node)

| Field           | Type                                                                                                          | Description                                                                                                                                                                                                  |
| --------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id`            | `ID!`                                                                                                         | A globally unique identifier. This ID is opaque and should not be parsed by clients.                                                                                                                         |
| `workspace`     | [Workspace](/docs/navixy-graphql-api/products/business-data-repository/api-reference/workspaces.md#workspace) | The workspace the event was recorded in. `auditEvents` and `entityHistory` list only the caller's workspace's events, so this is always the caller's workspace.                                              |
| `actor`         | [Actor](/docs/navixy-graphql-api/products/business-data-repository/api-reference/actors.md#actor)             | The actor who triggered the event.                                                                                                                                                                           |
| `ipAddress`     | `String`                                                                                                      | The client IP address.                                                                                                                                                                                       |
| `userAgent`     | `String`                                                                                                      | The client User-Agent string.                                                                                                                                                                                |
| `sourceType`    | [SourceType](#sourcetype)!                                                                                    | The source type of the request.                                                                                                                                                                              |
| `traceId`       | `String`                                                                                                      | The distributed tracing ID (32 hex characters) for log correlation.                                                                                                                                          |
| `aggregateType` | [Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)                                            | The type of entity affected: `asset`, `asset_group`, `catalog_item` (any catalog item), `custom_field_definition`, `device`, `geo_object`, `integration`, `inventory`, `member`, `schedule`, or `workspace`. |
| `aggregateId`   | `ID`                                                                                                          | The ID of the affected entity.                                                                                                                                                                               |
| `eventType`     | [AuditEventType](#auditeventtype)!                                                                            | The type of event that occurred.                                                                                                                                                                             |
| `eventData`     | [JSON](/docs/navixy-graphql-api/core-api-reference/common.md#json)                                            | The event payload with details such as changed fields.                                                                                                                                                       |
| `occurredAt`    | [DateTime](/docs/navixy-graphql-api/core-api-reference/common.md#datetime)!                                   | The date and time when the event occurred.                                                                                                                                                                   |

***

## Inputs

### AuditEventFilter

Filtering options for audit events.

| Field            | Type                                                                       | Description                                        |
| ---------------- | -------------------------------------------------------------------------- | -------------------------------------------------- |
| `actorIds`       | `[ID!]`                                                                    | Filter by actors (OR within field).                |
| `aggregateTypes` | \[[Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)!]     | Filter by entity types (OR within field).          |
| `aggregateIds`   | `[ID!]`                                                                    | Filter by specific entity IDs (OR within field).   |
| `eventTypes`     | \[[AuditEventType](#auditeventtype)!]                                      | Filter by event types (OR within field).           |
| `sourceTypes`    | \[[SourceType](#sourcetype)!]                                              | Filter by source types (OR within field).          |
| `traceId`        | `String`                                                                   | Filter by trace ID.                                |
| `from`           | [DateTime](/docs/navixy-graphql-api/core-api-reference/common.md#datetime) | Return events that occurred after this timestamp.  |
| `to`             | [DateTime](/docs/navixy-graphql-api/core-api-reference/common.md#datetime) | Return events that occurred before this timestamp. |

***

### AuditEventOrder

Ordering options for audit events.

| Field       | Type                                                                                    | Description             |
| ----------- | --------------------------------------------------------------------------------------- | ----------------------- |
| `field`     | [AuditEventOrderField](#auditeventorderfield)!                                          | The field to order by.  |
| `direction` | [OrderDirection](/docs/navixy-graphql-api/core-api-reference/common.md#orderdirection)! | The direction to order. |

***

## Enums

### SourceType

The source type identifying the origin of an API request.

| Value         | Description                                                                    |
| ------------- | ------------------------------------------------------------------------------ |
| `WEB`         | Not recorded. Every event has `API`.                                           |
| `MOBILE`      | Not recorded. Every event has `API`.                                           |
| `API`         | Recorded on every event, including the events the platform records on its own. |
| `INTERNAL`    | Not recorded. Every event has `API`.                                           |
| `INTEGRATION` | Not recorded. Every event has `API`.                                           |

***

### AuditEventType

The type of event recorded in the audit log.

| Value      | Description                                                                          |
| ---------- | ------------------------------------------------------------------------------------ |
| `CREATED`  | A new entity was created.                                                            |
| `UPDATED`  | An existing entity was modified.                                                     |
| `DELETED`  | An entity was deleted.                                                               |
| `RESTORED` | A workspace was restored. Recorded only when Navixy Console reactivates a workspace. |

***

### AuditEventOrderField

Fields available for ordering audit events.

| Value         | Description               |
| ------------- | ------------------------- |
| `OCCURRED_AT` | Order by occurrence date. |

***

## Pagination types

### AuditEventConnection

A paginated list of AuditEvent items.

**Implements:** [Connection](/docs/navixy-graphql-api/core-api-reference/common.md#connection)

| Field      | Type                                                                         | Description                                                |
| ---------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `edges`    | \[[AuditEventEdge](#auditeventedge)!]!                                       | A list of edges.                                           |
| `nodes`    | \[[AuditEvent](#auditevent)!]!                                               | A list of nodes in the connection (without edge metadata). |
| `pageInfo` | [PageInfo](/docs/navixy-graphql-api/core-api-reference/common.md#pageinfo)!  | Information about the current page.                        |
| `total`    | [CountInfo](/docs/navixy-graphql-api/core-api-reference/common.md#countinfo) | The total count of items matching the filter.              |

***

### AuditEventEdge

An edge in the AuditEvent connection.

**Implements:** [Edge](/docs/navixy-graphql-api/core-api-reference/common.md#edge)

| Field    | Type                       | Description                             |
| -------- | -------------------------- | --------------------------------------- |
| `cursor` | `String!`                  | An opaque cursor for this edge.         |
| `node`   | [AuditEvent](#auditevent)! | The audit event at the end of the edge. |

***

## See also

* [Pagination](/docs/navixy-graphql-api/pagination.md)
* [Filtering and sorting](/docs/navixy-graphql-api/filtering-and-sorting.md)
* [Error handling](/docs/navixy-graphql-api/error-handling.md)
* [Optimistic locking](/docs/navixy-graphql-api/optimistic-locking.md)
* [Limits](/docs/navixy-graphql-api/limits.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/audit.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.