Entity History

Replay one entity’s delta chain into the document as it stood at at. With at omitted the result should equal the live document; a mismatch means something wrote past the log.

GET/api/v1/audit-logs/{entity_type}/{entity_id}/history

Authorization

AuthorizationBearer token · headerrequired

AuthorizationOAuth2 access token · headerrequired

Path parameters

entity_typestringrequired

entity_idstringrequired

Query parameters

atstring<date-time> | any

Reconstruct as of this moment; omit for now

Responses

200Successful Response

successboolean

default: true

dataEntityHistory | any

Show properties

Any of:

EntityHistory

entity_typestringrequired

entity_idstringrequired

rowsintegerrequired

documentobject | anyrequired

Show properties

Any of:

object

object

any

any

any

any

messagestring | any

Show properties

Any of:

string

string

any

any

errorsstring[] | any

Show properties

Any of:

string[]

Array of string

string

any

any

422Validation Error

detailValidationError[]

Show properties

Array of ValidationError

locstring | integer[]required

Show properties

Array of string | integer

Any of:

string

string

integer

integer

msgstringrequired

typestringrequired

inputany

ctxobject

Request

curl -X GET "/api/v1/audit-logs/string/string/history" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("/api/v1/audit-logs/string/string/history", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "/api/v1/audit-logs/string/string/history",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "success": true,
  "data": {
    "entity_type": "string",
    "entity_id": "string",
    "rows": 0,
    "document": {}
  },
  "message": "string",
  "errors": [
    "string"
  ]
}