audit_events

GET

/console/sessions/{id}/events

const url = 'https://api.canopyhq.dev/console/sessions/000000000000000000000000000000000000000000000000000000000000000000000000/events';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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://api.canopyhq.dev/console/sessions/000000000000000000000000000000000000000000000000000000000000000000000000/events \
  --header 'Authorization: Bearer <token>'

Authorizations

console_token

Parameters

Path Parameters

required

A stream id: 72 hex chars, the shard then the owner digest.

string

The session to read.

Query Parameters

opened

string

opened=1 serves every record the session landed, addressed ones included, and opens each call’s arguments; owners, on an ended session.

Responses

200

One JSON line per record: {"Ok": <record>}. Plain, the public records alone. Opened, every record the session landed, at every cursor from one to the tip, with each call on a turn carrying arguments and each completion its result, or an error saying why not; the authorizer’s invoke.allowed is served without its gate.

application/jsonstream

A landed record: the envelope plus the opaque body beneath it.

object

body

required

The opaque layers beneath the envelope.

envelope

required

The envelope: the only surface the filter is evaluated on. Trellis never reads beneath it.

object

required

Unix milliseconds, minted with the cursor at the single point of intake.

integer format: int64

cursor

required

Monotonic per-stream position, minted at the single point of intake. Producers never carry or assert one.

integer format: int64

idem

One of:

null
string

null

kind

required

A kind string and the version of its body, one unit.

object

name

required

string

version

required

integer format: int32

producer

required

Who landed a record. Asserted on the offer, checked by the write clause.

string

size

required

integer format: int32

stream

required

A stream id: 72 hex chars, the shard then the owner digest.

string

One of:

null
string

null

Example

{
  "envelope": {
    "stream": "000000000000000000000000000000000000000000000000000000000000000000000000"
  }
}

400

A query string that did not parse.

401

No console token, or one that did not verify.

403

Only an owner reads the opened face.

404

No such session under this tenant.

409

The session is still live; the opened face waits for its end.