List Audit Events

GET

audit-events

List Audit Events

curl --request GET \
  --url https://api.example.com/audit-events \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/audit-events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/audit-events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/audit-events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/audit-events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "entity_type": "<string>",
      "entity_id": "<string>",
      "action": "<string>",
      "actor_type": "<string>",
      "source": "<string>",
      "user_id": "<string>",
      "actor_id": "<string>",
      "actor_email": "<string>",
      "actor_name": "<string>",
      "resource_name": "<string>",
      "metadata": {},
      "org_id": "<string>"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-notte-request-origin

string | null

x-notte-sdk-version

string | null

Query Parameters

limit

integer

default:50

Events per page

Required range: 1 <= x <= 100

cursor

string | null

next_cursor from the previous page

since

string<date-time> | null

Only events at or after this time (ISO-8601)

until

string<date-time> | null

Only events before this time (ISO-8601)

action

string | null

Only events with this action, e.g. created

entity_type

string | null

Only events about this kind of resource, e.g. api_key

actor_id

string | null

Only events performed by this user

Response

Successful Response

items

AuditEvent · object[]

required

Show child attributes

has_more

boolean

required

next_cursor

string | null

Opaque cursor for the next (older) page. Null when there are no more events.

⌘I

List Audit Events

curl --request GET \
  --url https://api.example.com/audit-events \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/audit-events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/audit-events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/audit-events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/audit-events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "entity_type": "<string>",
      "entity_id": "<string>",
      "action": "<string>",
      "actor_type": "<string>",
      "source": "<string>",
      "user_id": "<string>",
      "actor_id": "<string>",
      "actor_email": "<string>",
      "actor_name": "<string>",
      "resource_name": "<string>",
      "metadata": {},
      "org_id": "<string>"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Getting Started

APIs

Python SDK

Node SDK

List Audit Events

Authorizations

Headers

Query Parameters

Response