GET
/
v1
/
auditLogs
Get audit logs
curl --request GET \
  --url https://api.metronome.com/v1/auditLogs \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "actor": {
        "id": "<string>",
        "email": "<string>",
        "name": "<string>"
      },
      "request": {
        "id": "<string>",
        "ip": "<string>",
        "user_agent": "<string>"
      },
      "resource_type": "<string>",
      "resource_id": "<string>",
      "action": "<string>",
      "status": "success",
      "description": "<string>"
    }
  ],
  "next_page": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer

Max number of results that should be returned

Required range: 1 <= x <= 100
next_page
string

Cursor that indicates where the next page of results should start.

starting_on
string<date-time>

RFC 3339 timestamp of the earliest audit log to return. Cannot be used with 'next_page'.

ending_before
string<date-time>

RFC 3339 timestamp (exclusive). Cannot be used with 'next_page'.

sort
enum<string>

Sort order by timestamp, e.g. date_asc or date_desc. Defaults to date_asc.

Available options:
date_asc,
date_desc
resource_id
string

Optional parameter that can be used to filter which audit logs are returned. If you specify resource_id, you must also specify resource_type.

resource_type
string

Optional parameter that can be used to filter which audit logs are returned. If you specify resource_type, you must also specify resource_id.

Response

200 - application/json

Success

The response is of type object.