/events

GET /events

List API events

Retrieve logged API events for auditing and debugging

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Required Parameters

x-account-id header string

Account ID for the request

Optional Parameters

Click here to view an exhaustive list of all available parameters

page query integer

pageSize query integer

method query string

path query string

statusCode query integer

userId query string

Try it out

Output:

Responses

Description

Events retrieved successfully

{
  "data": [
    {
      "event": "string",
      "name": "string",
      "description": "string",
      "id": "string",
      "method": "string",
      "path": "string",
      "statusCode": 0,
      "userId": "string",
      "duration": 0,
      "timestamp": "string"
    }
  ],
  "page": 0,
  "pageSize": 0,
  "total": 0
}

References

#/components/parameters/xAccountIdHeader #/components/schemas/Event

in: header
name: x-account-id
schema:
  type: string
description: Account ID for the request
required: true
example: "2311"

|
export type xAccountIdHeader = any; // Schema type not fully supported

#/components/schemas/Event

OpenAPI
TypeScript

type: object
properties:
  event:
    type: string
    readOnly: true
    description: The event type
  name:
    type: string
    description: The name of the event
  description:
    type: string
    description: The description of the event
  id:
    type: string
  method:
    type: string
  path:
    type: string
  statusCode:
    type: integer
  userId:
    type: string
    nullable: true
  duration:
    type: number
  timestamp:
    type: string
    format: date-time
required:
  - event
  - name
  - description

|
export interface Event {
  /** The event type */
  event: string;
  /** The name of the event */
  name: string;
  /** The description of the event */
  description: string;
  id?: string;
  method?: string;
  path?: string;
  statusCode?: number;
  userId?: string;
  duration?: number;
  timestamp?: Date;
}

Route Source Code

Check out the source code for this route entrypoint here: /events/route.ts

Or the swagger.yaml spec this documentation was generated from: /events/swagger.yaml