> ## Documentation Index
> Fetch the complete documentation index at: https://docs.assetinfinity.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# The audit trail, one row per event, for reports and dashboard tiles: sign-ins and refusals, changes to who may do what…
> The audit trail, one row per event, for reports and dashboard tiles: sign-ins and refusals, changes to who may do what, and changes to records. Each row says what kind of event it was
(category), what happened (event), whether it went through (outcome), who and from where, and which
fields changed. Before and after values are not included. Returns no rows without admin.audit.view.
## OpenAPI
````yaml /api-reference/openapi.json get /audit_events
openapi: 3.0.0
info:
description: ''
title: >-
The only schema PostgREST exposes. Reads are security_invoker views; writes
are SECURITY DEFINER functions. Rebuilt wholesale on every deploy — it holds
no data.
version: 12.2.3
servers:
- url: https://app.assetinfinity.ai/api
security: []
tags:
- name: Signing in
- name: Profile
- name: My work
- name: Sites and locations
- name: Assets
- name: Asset lifecycle
- name: Asset components
- name: Kits
- name: Work lifecycle
- name: Work order execution
- name: Work sequencing
- name: Maintenance
- name: Inspections
- name: Checklists
- name: Verification
- name: Self verification
- name: Inventory
- name: Inventory detail
- name: Parts demand
- name: Procurement
- name: Catalogue
- name: Vendors and contracts
- name: Contracts
- name: Amendments
- name: Vendor spend forecast
- name: Workforce
- name: Workforce detail
- name: Capacity
- name: Dispatch
- name: Shutdown
- name: Permits
- name: Tools
- name: Tools on jobs
- name: Bookings
- name: Booking hand over
- name: Booking bills
- name: Calibration history
- name: Reliability
- name: Sensors and meters
- name: Readers
- name: Trackers
- name: Real-time location
- name: Feeds
- name: Energy
- name: IT assets
- name: IT asset software
- name: IT asset topology
- name: Warranty lookups
- name: Map
- name: Floor plans
- name: Labels
- name: Lost and found
- name: Visitors
- name: Root cause analysis
- name: Costing
- name: Finance
- name: E-way bills
- name: E-way bill filing
- name: Budgets
- name: Capex plans
- name: Capex consolidation
- name: Capex capitalization
- name: Capex change logs
- name: FF&E plans
- name: Documents
- name: Document control
- name: Document folders
- name: Document tree
- name: Knowledge
- name: Reports
- name: Dashboards
- name: Extracts
- name: Data exports
- name: Audit center
- name: Audit feed
- name: User activity
- name: Activity
- name: Conversations
- name: Notifications
- name: Date reminders
- name: Channels
- name: Search
- name: Copilot
- name: Import
- name: Bulk jobs
- name: File exchange
- name: Filing exceptions
- name: Files
- name: Sync
- name: Support
- name: API keys
- name: Webhooks
- name: MCP connections
- name: MCP sign-in
- name: SCIM provisioning
- name: Directory sync
- name: Security streams
- name: Clarity
- name: Single sign-on
- name: Two-factor sign-in
- name: Admin
- name: Access
- name: Lookups
- name: Read models
- name: Reference
- name: Reference columns
- name: Reference entry
- name: List views
- name: Mapping
- name: Numbering
- name: Branding
- name: Custom fields
- name: Form studio
- name: Workflows
- name: Workflow studio
- name: Rules
- name: Statuses and transitions
- name: Currencies and locales
- name: Today
- name: Work configuration
- name: Asset configuration
- name: Inventory configuration
- name: Tool configuration
- name: Workforce configuration
- name: Vendor and contract configuration
- name: Document configuration
- name: Inspection configuration
- name: Sites, locations and the organisation
- name: Setup
- name: Features
- name: Billing
- name: Licence
- name: Welcome
- name: Tray
- name: Tenant switch
- name: Release
- name: Upgrade
- name: Telegram
- name: Whatsapp
- name: Inbound mail
- name: Platform
externalDocs:
description: PostgREST Documentation
url: https://postgrest.org/en/v12/references/api.html
paths:
/audit_events:
get:
tags:
- Audit center
summary: >-
The audit trail, one row per event, for reports and dashboard tiles:
sign-ins and refusals, changes to who may do what…
description: >-
The audit trail, one row per event, for reports and dashboard tiles:
sign-ins and refusals, changes to who may do what, and changes to
records. Each row says what kind of event it was
(category), what happened (event), whether it went through (outcome),
who and from where, and which
fields changed. Before and after values are not included. Returns no
rows without admin.audit.view.
parameters:
- $ref: '#/components/parameters/rowFilter.audit_events.id'
- $ref: '#/components/parameters/rowFilter.audit_events.occurred_at'
- $ref: '#/components/parameters/rowFilter.audit_events.category'
- $ref: '#/components/parameters/rowFilter.audit_events.event'
- $ref: '#/components/parameters/rowFilter.audit_events.outcome'
- $ref: '#/components/parameters/rowFilter.audit_events.event_type'
- $ref: '#/components/parameters/rowFilter.audit_events.action'
- $ref: '#/components/parameters/rowFilter.audit_events.user_id'
- $ref: '#/components/parameters/rowFilter.audit_events.user_name'
- $ref: '#/components/parameters/rowFilter.audit_events.user_email'
- $ref: '#/components/parameters/rowFilter.audit_events.service'
- $ref: '#/components/parameters/rowFilter.audit_events.ip_address'
- $ref: '#/components/parameters/rowFilter.audit_events.channel'
- $ref: '#/components/parameters/rowFilter.audit_events.reason'
- $ref: '#/components/parameters/rowFilter.audit_events.record_type'
- $ref: '#/components/parameters/rowFilter.audit_events.entity_type'
- $ref: '#/components/parameters/rowFilter.audit_events.record_id'
- $ref: '#/components/parameters/rowFilter.audit_events.changed_fields'
- $ref: '#/components/parameters/rowFilter.audit_events.summary'
- $ref: '#/components/parameters/rowFilter.audit_events.request_id'
- $ref: '#/components/parameters/select'
- $ref: '#/components/parameters/order'
- $ref: '#/components/parameters/range'
- $ref: '#/components/parameters/rangeUnit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/preferCount'
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/audit_events'
type: array
application/vnd.pgrst.object+json:
schema:
items:
$ref: '#/components/schemas/audit_events'
type: array
application/vnd.pgrst.object+json;nulls=stripped:
schema:
items:
$ref: '#/components/schemas/audit_events'
type: array
text/csv:
schema:
items:
$ref: '#/components/schemas/audit_events'
type: array
description: OK
'206':
description: Partial Content
components:
parameters:
rowFilter.audit_events.id:
in: query
name: id
required: false
schema:
type: string
rowFilter.audit_events.occurred_at:
in: query
name: occurred_at
required: false
schema:
type: string
rowFilter.audit_events.category:
in: query
name: category
required: false
schema:
type: string
rowFilter.audit_events.event:
in: query
name: event
required: false
schema:
type: string
rowFilter.audit_events.outcome:
in: query
name: outcome
required: false
schema:
type: string
rowFilter.audit_events.event_type:
in: query
name: event_type
required: false
schema:
type: string
rowFilter.audit_events.action:
in: query
name: action
required: false
schema:
type: string
rowFilter.audit_events.user_id:
in: query
name: user_id
required: false
schema:
type: string
rowFilter.audit_events.user_name:
in: query
name: user_name
required: false
schema:
type: string
rowFilter.audit_events.user_email:
in: query
name: user_email
required: false
schema:
type: string
rowFilter.audit_events.service:
in: query
name: service
required: false
schema:
type: string
rowFilter.audit_events.ip_address:
in: query
name: ip_address
required: false
schema:
type: string
rowFilter.audit_events.channel:
in: query
name: channel
required: false
schema:
type: string
rowFilter.audit_events.reason:
in: query
name: reason
required: false
schema:
type: string
rowFilter.audit_events.record_type:
in: query
name: record_type
required: false
schema:
type: string
rowFilter.audit_events.entity_type:
in: query
name: entity_type
required: false
schema:
type: string
rowFilter.audit_events.record_id:
in: query
name: record_id
required: false
schema:
type: string
rowFilter.audit_events.changed_fields:
in: query
name: changed_fields
required: false
schema:
type: string
rowFilter.audit_events.summary:
in: query
name: summary
required: false
schema:
type: string
rowFilter.audit_events.request_id:
in: query
name: request_id
required: false
schema:
type: string
select:
description: Filtering Columns
in: query
name: select
required: false
schema:
type: string
order:
description: Ordering
in: query
name: order
required: false
schema:
type: string
range:
description: Limiting and Pagination
in: header
name: Range
required: false
schema:
type: string
rangeUnit:
description: Limiting and Pagination
in: header
name: Range-Unit
required: false
schema:
default: items
type: string
offset:
description: Limiting and Pagination
in: query
name: offset
required: false
schema:
type: string
limit:
description: Limiting and Pagination
in: query
name: limit
required: false
schema:
type: string
preferCount:
description: Preference
in: header
name: Prefer
required: false
schema:
enum:
- count=none
type: string
schemas:
audit_events:
description: >-
The audit trail, one row per event, for reports and dashboard tiles:
sign-ins and refusals,
changes to who may do what, and changes to records. Each row says what
kind of event it was
(category), what happened (event), whether it went through (outcome),
who and from where, and which
fields changed. Before and after values are not included. Returns no
rows without admin.audit.view.
properties:
action:
format: text
type: string
category:
format: text
type: string
changed_fields:
format: text
type: string
channel:
format: text
type: string
entity_type:
format: text
type: string
event:
format: text
type: string
event_type:
format: text
type: string
id:
description: |-
Note:
This is a Primary Key.
format: uuid
type: string
ip_address:
format: text
type: string
occurred_at:
description: |-
Note:
This is a Primary Key.
format: timestamp with time zone
type: string
outcome:
format: text
type: string
reason:
format: text
type: string
record_id:
format: uuid
type: string
record_type:
format: text
type: string
request_id:
format: text
type: string
service:
format: text
type: string
summary:
format: text
type: string
user_email:
format: text
type: string
user_id:
format: uuid
type: string
user_name:
format: text
type: string
type: object
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.