Skip to content
AveraAveraAvera Documentation

Read a project's audit trail

GET
/api/v1/projects/{projectId}/audit-trail
curl --request GET \
  --url 'https://app.avera.io/api/v1/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/audit-trail?page=0&pageSize=50'

One page of the unified, append-only trail: item, relationship and document body entries come from version provenance, everything else from audit entries, so every mutation is recorded in exactly one register and appears exactly once. Guarded by item read on the project, because a version’s stamp is part of the design record. On large histories the total is reported as a lower bound.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string format: uuid

Query Parameters

Section titled “Query Parameters”
whatHappened
Array<string>
actorId
string format: uuid
entityType
string
entityId
string format: uuid
from
string format: date-time
to
string format: date-time
page
integer format: int32
0
pageSize
integer format: int32
default: 50

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
object
items
required
Array<object>
object
id
required
string format: uuid
source
required
string
projectId
string | null format: uuid
branchId
string | null format: uuid
occurredAt
required
string format: date-time
actorId
required
string format: uuid
actorKind
required
string
actorName
string | null
actorEmail
string | null
whatHappened
required
string
entityType
required
string
entityId
required
string format: uuid
entityNumber
string | null
seq
integer | null format: int64
detail
One of:
object
container
boolean
nodeType
string
Allowed values: ARRAY BINARY BOOLEAN MISSING NULL NUMBER OBJECT POJO STRING
string
boolean
integralNumber
boolean
missingNode
boolean
valueNode
boolean
pojo
boolean
number
boolean
short
boolean
int
boolean
long
boolean
double
boolean
bigDecimal
boolean
bigInteger
boolean
textual
boolean
boolean
boolean
binary
boolean
floatingPointNumber
boolean
empty
boolean
array
boolean
null
boolean
object
boolean
float
boolean
embeddedValue
boolean
changes
One of:
object
container
boolean
nodeType
string
Allowed values: ARRAY BINARY BOOLEAN MISSING NULL NUMBER OBJECT POJO STRING
string
boolean
integralNumber
boolean
missingNode
boolean
valueNode
boolean
pojo
boolean
number
boolean
short
boolean
int
boolean
long
boolean
double
boolean
bigDecimal
boolean
bigInteger
boolean
textual
boolean
boolean
boolean
binary
boolean
floatingPointNumber
boolean
empty
boolean
array
boolean
null
boolean
object
boolean
float
boolean
embeddedValue
boolean
correlationId
string | null
clientIp
string | null
userAgent
string | null
referencedItems
required
object
key
additional properties
object
number
required
string
itemTypeId
required
string
icon
string | null
color
string | null
branchKey
string | null
branchName
string | null
attributeLabels
required
object
key
additional properties
string
total
required
integer format: int64
page
required
integer format: int32
pageSize
required
integer format: int32
hasNext
required
boolean
totalIsLowerBound
required
boolean