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

List

Get audit logs
client.V1.AuditLogs.List(ctx, query) (*CursorPage[IDstringRequestV1AuditLogListResponseRequestTimestampTimeActionstringActorV1AuditLogListResponseActorDescriptionstringResourceIDstringResourceTypestringStatusV1AuditLogListResponseStatusV1AuditLogListResponse], error)
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
queryEndingBeforefieldLimitfieldNextPagefieldResourceIDfieldResourceTypefieldSortfieldStartingOnfieldV1AuditLogListParams
Hide ParametersShow Parameters
EndingBeforefield
optional
param.Field[Time]

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

formatdate-time
Limitfield
optional
param.Field[int64]

Max number of results that should be returned

minimum1
maximum100
NextPagefield
optional
param.Field[string]

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

ResourceIDfield
optional
param.Field[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.

ResourceTypefield
optional
param.Field[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.

Sortfield
optional

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

Hide ParametersShow Parameters
V1AuditLogListParamsSortDateAscconst
"date_asc"
V1AuditLogListParamsSortDateDescconst
"date_desc"
StartingOnfield
optional
param.Field[Time]

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

formatdate-time
Returns
V1AuditLogListResponsestruct
Hide ParametersShow Parameters
IDstring
RequestIDstringIPstringUserAgentstringV1AuditLogListResponseRequest
Hide ParametersShow Parameters
IDstring
IPstring
optional
UserAgentstring
optional
TimestampTime
formatdate-time
Actionstring
optional
ActorIDstringNamestringEmailstringV1AuditLogListResponseActor
optional
Hide ParametersShow Parameters
IDstring
Namestring
Emailstring
optional
Descriptionstring
optional
ResourceIDstring
optional
ResourceTypestring
optional
StatusV1AuditLogListResponseStatusSuccessV1AuditLogListResponseStatusV1AuditLogListResponseStatusFailureV1AuditLogListResponseStatusV1AuditLogListResponseStatusPendingV1AuditLogListResponseStatusV1AuditLogListResponseStatus
optional
Hide ParametersShow Parameters
V1AuditLogListResponseStatusSuccessconst
V1AuditLogListResponseStatusSuccessV1AuditLogListResponseStatusV1AuditLogListResponseStatusFailureV1AuditLogListResponseStatusV1AuditLogListResponseStatusPendingV1AuditLogListResponseStatusV1AuditLogListResponseStatus
"success"
V1AuditLogListResponseStatusFailureconst
V1AuditLogListResponseStatusSuccessV1AuditLogListResponseStatusV1AuditLogListResponseStatusFailureV1AuditLogListResponseStatusV1AuditLogListResponseStatusPendingV1AuditLogListResponseStatusV1AuditLogListResponseStatus
"failure"
V1AuditLogListResponseStatusPendingconst
V1AuditLogListResponseStatusSuccessV1AuditLogListResponseStatusV1AuditLogListResponseStatusFailureV1AuditLogListResponseStatusV1AuditLogListResponseStatusPendingV1AuditLogListResponseStatusV1AuditLogListResponseStatus
"pending"
package main

import (
  "context"
  "fmt"

  "github.com/Metronome-Industries/metronome-go"
  "github.com/Metronome-Industries/metronome-go/option"
)

func main() {
  client := metronome.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  page, err := client.V1.AuditLogs.List(context.TODO(), metronome.V1AuditLogListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}
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"
}