/event-list

GET /event-list

Get the list of events

Retrieves a list of events with their names and descriptions

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Try it out

Output:

Responses

Description

A list of events

{
  "events": [
    {
      "event": "string",
      "name": "string",
      "description": "string",
      "id": "string",
      "method": "string",
      "path": "string",
      "statusCode": 0,
      "userId": "string",
      "duration": 0,
      "timestamp": "string"
    }
  ]
}

References

#/components/schemas/Event #/components/schemas/EventList

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;
}

#/components/schemas/EventList

OpenAPI
TypeScript

type: object
properties:
  events:
    type: array
    items:
      $ref: "#/components/schemas/Event"
required:
  - events

|
export interface EventList {
  events: Event[];
}

Route Source Code

Check out the source code for this route entrypoint here: /event-list/route.ts

Or the swagger.yaml spec this documentation was generated from: /event-list/swagger.yaml