Skip to content
Metronome Docs
  • Auto
  • Light
  • Dark
Talk to an expert

List

API Reference
V1
Audit Logs
Get audit logs
client.v1.auditLogs.list(AuditLogListParamsquery?, RequestOptionsoptions?): CursorPage<idstringrequestRequesttimestampstringactionstringactorActordescriptionstringresource_idstringresource_typestringstatusunionAuditLogListResponse>
get/v1/auditLogs

Retrieves a range of audit logs. If no further audit logs are currently available, the data array will be empty. As new audit logs are created, subsequent requests using the same next_page value will be in the returned data array, ensuring a continuous and uninterrupted reading of audit logs.

Parameters
queryending_beforestringlimitnumbernext_pagestringresource_idstringresource_typestringsortunionstarting_onstringAuditLogListParams
Hide ParametersShow Parameters
ending_beforestring
optional

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

formatdate-time
limitnumber
optional

Max number of results that should be returned

minimum1
maximum100
next_pagestring
optional

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

resource_idstring
optional

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_typestring
optional

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

sortunion
optional
"date_asc" | "date_desc"

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

Hide ParametersShow Parameters
"date_asc"
"date_desc"
starting_onstring
optional

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

formatdate-time
Returns
AuditLogListResponse
Hide ParametersShow Parameters
idstring
requestidstringipstringuser_agentstringRequest
Hide ParametersShow Parameters
idstring
ipstring
optional
user_agentstring
optional
timestampstring
formatdate-time
actionstring
optional
actoridstringnamestringemailstringActor
optional
Hide ParametersShow Parameters
idstring
namestring
emailstring
optional
descriptionstring
optional
resource_idstring
optional
resource_typestring
optional
statusunion
optional
"success" | "failure" | "pending"
Hide ParametersShow Parameters
"success"
"failure"
"pending"
import Metronome from '@metronome/sdk';

const client = new Metronome({
  bearerToken: 'My Bearer Token',
});

// Automatically fetches more pages as needed.
for await (const auditLogListResponse of client.v1.auditLogs.list()) {
  console.log(auditLogListResponse.id);
}
200 Example
{
  "data": [
    {
      "id": "id",
      "request": {
        "id": "id",
        "ip": "ip",
        "user_agent": "user_agent"
      },
      "timestamp": "2019-12-27T18:11:19.117Z",
      "action": "action",
      "actor": {
        "id": "id",
        "name": "name",
        "email": "email"
      },
      "description": "description",
      "resource_id": "resource_id",
      "resource_type": "resource_type",
      "status": "success"
    }
  ],
  "next_page": "next_page"
}