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.

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.
after	String	The elements that come after the specified cursor.
last	Int	The last n elements from the paginated list.
before	String	The elements that come before the specified cursor.
orderBy	AuditEventOrder	The ordering options for the returned audit events.

Input types:

AuditEventFilter

Filtering options for audit events.

Field	Type	Description
actorIds	[ID!]	Filter by actors (OR within field).
aggregateTypes	[Code!]	Filter by entity types (OR within field).
aggregateIds	[ID!]	Filter by specific entity IDs (OR within field).
eventTypes	[AuditEventType!]	Filter by event types (OR within field).
sourceTypes	[SourceType!]	Filter by source types (OR within field).
traceId	String	Filter by trace ID.
from	DateTime	Return events that occurred after this timestamp.
to	DateTime	Return events that occurred before this timestamp.

AuditEventOrder

Ordering options for audit events.

Field	Type	Description
field	AuditEventOrderField!	The field to order by.
direction	OrderDirection!	The direction to order.

Output types:

AuditEventConnection

A paginated list of AuditEvent items.

Implements: Connection

Field	Type	Description
edges	[AuditEventEdge!]!	A list of edges.
nodes	[AuditEvent!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

---

entityHistory

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

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.
after	String	The elements that come after the specified cursor.
last	Int	The last n elements from the paginated list.
before	String	The elements that come before the specified cursor.
orderBy	AuditEventOrder	The ordering options for the returned audit events.

Input types:

AuditEventFilter

Filtering options for audit events.

Field	Type	Description
actorIds	[ID!]	Filter by actors (OR within field).
aggregateTypes	[Code!]	Filter by entity types (OR within field).
aggregateIds	[ID!]	Filter by specific entity IDs (OR within field).
eventTypes	[AuditEventType!]	Filter by event types (OR within field).
sourceTypes	[SourceType!]	Filter by source types (OR within field).
traceId	String	Filter by trace ID.
from	DateTime	Return events that occurred after this timestamp.
to	DateTime	Return events that occurred before this timestamp.

AuditEventOrder

Ordering options for audit events.

Field	Type	Description
field	AuditEventOrderField!	The field to order by.
direction	OrderDirection!	The direction to order.

Output types:

AuditEventConnection

A paginated list of AuditEvent items.

Implements: Connection

Field	Type	Description
edges	[AuditEventEdge!]!	A list of edges.
nodes	[AuditEvent!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

---

Objects

AuditEvent

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

Implements: Node

Field	Type	Description
id	ID!	A globally unique identifier. This ID is opaque and should not be parsed by clients.
workspace	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	The actor who triggered the event.
ipAddress	String	The client IP address.
userAgent	String	The client User-Agent string.
sourceType	SourceType!	The source type of the request.
traceId	String	The distributed tracing ID (32 hex characters) for log correlation.
aggregateType	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!	The type of event that occurred.
eventData	JSON	The event payload with details such as changed fields.
occurredAt	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!]	Filter by entity types (OR within field).
aggregateIds	[ID!]	Filter by specific entity IDs (OR within field).
eventTypes	[AuditEventType!]	Filter by event types (OR within field).
sourceTypes	[SourceType!]	Filter by source types (OR within field).
traceId	String	Filter by trace ID.
from	DateTime	Return events that occurred after this timestamp.
to	DateTime	Return events that occurred before this timestamp.

---

AuditEventOrder

Ordering options for audit events.

Field	Type	Description
field	AuditEventOrderField!	The field to order by.
direction	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

Field	Type	Description
edges	[AuditEventEdge!]!	A list of edges.
nodes	[AuditEvent!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

---

AuditEventEdge

An edge in the AuditEvent connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	AuditEvent!	The audit event at the end of the edge.

---

See also

• Pagination

• Filtering and sorting

• Error handling

• Optimistic locking

• Limits