VRPlatformVRPlatform
Audit

/audit/timeline

List a unified audit timeline for a root entity across actions/effects/attempts/mutations/journal deltas.

GET
/audit/timeline
X-API-Key<token>

API key provided in dashboard

In: header

Query Parameters

rootEntityType*string
rootEntityId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
types?array<string>

Timeline item type filter. Accepts repeated types=value query params or one comma-separated string.

Items1 <= items <= 5
from?string

Temporal boundary string parsed by the API. Prefer YYYY-MM-DD for day-granularity filters or an ISO 8601 timestamp for exact time bounds.

Formatvrp-time-boundary
to?string

Temporal boundary string parsed by the API. Prefer YYYY-MM-DD for day-granularity filters or an ISO 8601 timestamp for exact time bounds.

Formatvrp-time-boundary
includeDiff?boolean

When true, include diff payloads in audit timeline journal delta entries.

Defaulttrue
limit?integer
Default50
Range1 <= value <= 100
cursor?string

Opaque pagination cursor returned by a previous response. Pass it back unchanged.

Formatvrp-opaque-cursor

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.vrplatform.app/audit/timeline?rootEntityType=string&rootEntityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "data": [
    {
      "type": "action",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "timestamp": "string",
      "actionId": "4a2794ff-94cb-4bac-8d36-d5fb36c563a0",
      "effectId": "eed930b6-0e6c-476e-a5ed-f8e56fb2d0f2",
      "mutationId": "07a10364-43fa-4ac9-ba37-9ba016453dbb",
      "rootEntityType": "string",
      "rootEntityId": "ffcdb974-7dd1-4727-b1cd-39415010f491",
      "data": {
        "actionType": "string",
        "message": "string",
        "payload": {},
        "source": "string",
        "apiVersion": "string",
        "requestId": "string",
        "traceId": "string",
        "parentActionId": "12f46041-18d6-4f38-a710-58558c6996db",
        "actor": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "type": "string",
          "name": "string",
          "email": "string"
        }
      }
    }
  ],
  "page": {
    "limit": 1,
    "hasMore": true,
    "nextCursor": "string"
  }
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}