Page through the audit log

GET

/api/v1/audit/page

const url = 'https://digize.com/api/v1/audit/page';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://digize.com/api/v1/audit/page \
  --header 'x-api-key: <x-api-key>'

A page of the last 60 days of changes, the newest first, narrowed by area (category), by who did it (a member’s user id, which also finds the agent and Digize staff acting as them, or kind:api_key, kind:system and the like), by dates, or by words in what happened. Pass nextCursor back as cursor for the next page.

Needs the settings:read permission.

Authorizations

apiKey
bearer

Parameters

Query Parameters

search

string

<= 200 characters

category

Array<string>

<= 50 items

actor

Array<string>

<= 50 items

from

string format: date-time

cursor

The nextCursor of the page before. Leave it out for the first page.

string

<= 400 characters

The nextCursor of the page before. Leave it out for the first page.

limit

Rows on the page: 50 unless it says, 100 at most.

integer

>= 1 <= 100

Rows on the page: 50 unless it says, 100 at most.

Responses

200

Done

application/json

object

rows

required

Array<object>

object

required

string

actor

required

object

kind

required

string

Allowed values: member api_key agent operator system

name

required

string

detail

required

string

action

required

string

category

required

string

summary

required

string

target

required

string

required

string format: date-time

data

required

object

key

additional properties

nextCursor

required

Pass it as cursor for the next page; null on the last.

string | null

Example

{
  "rows": [
    {
      "actor": {
        "kind": "member"
      }
    }
  ]
}

400

What was sent isn’t valid (invalid).

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}