List Audit Log entries.

GET 
/audit-log/

Request

Query Parameters

end_dt date-time

Include instances created before ISO-formatted timestamp

length integer

Number of results to return per page.

ordering string

Which field to use when ordering the results.

page integer

A page number within the paginated result set.

search string

A search term.

start_dt date-time

Include instances created after ISO-formatted timestamp

user string

Base58 ID to filter instances by the user linked to the entry

Responses

200

application/json

Schema

Schema

count integer

Total number of results.

page_total integer

Total number of pages.

page integer

Number of the current page.
The first page is 1.
Defaults to 1 if no specific page is requested.

length integer

Number of results returned per page.

results

object[]

Array [

user_id stringrequired

ID of the user who made the change.

username stringrequired

Username of the user who made the change.

user_name stringrequired

Name of the user who made the change.

date date-timerequired

Date and time of the change.

object_model stringrequired

Type of the changed object.

object_id stringrequired

ID of the changed object.

updated_fields

object

required

List of updated fields.

field_name

object[]

required

Name of updated field.

Array [

old_value stringrequired

Original value of the field.

new_value stringrequired

New value of the field.

]

]

Example (from schema)

{
  "count": 6,
  "page_total": 1,
  "page": 1,
  "length": 10,
  "results": [
    {
      "user_id": "string",
      "username": "string",
      "user_name": "string",
      "date": "2024-07-29T15:51:28.071Z",
      "object_model": "string",
      "object_id": "string",
      "updated_fields": {
        "field_name": [
          {
            "old_value": "string",
            "new_value": "string"
          }
        ]
      }
    }
  ]
}

400

application/json

Schema

Schema

<field name> string[]
non_field_errors string[]

Example (from schema)

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

401

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Incorrect authentication credentials."
}

500

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Unexpected error while handling your request."
}

Loading...