RateLimitExceededEvent

  • eventId
    Type: string Format: uuid
    required
  • eventType
    enum
    const:  
    rate_limit.exceeded
    required
    values
    • rate_limit.exceeded
  • rateLimit
    Type: object
    required
    • exceededBy
      Type: integer
      required

      Integer numbers.

    • limit
      Type: integer
      required

      Integer numbers.

    • window
      Type: string Format: duration
      required
  • timestamp
    Type: string Format: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • metadata
    Type: object · EventMetadata
    • correlationId
      Type: string

      Correlation ID for tracing related events

    • requestId
      Type: string

      ID of the request that triggered the event

    • severity
      Type: string enum

      Event severity level

      values
      • info
      • warning
      • error
      • critical
    • source
      Type: string

      Source system that generated the event

    • userId
      Type: integer Format: int64

      ID of the user who triggered the event (if applicable)

  • request
    Type: object
    • endpoint
      Type: string
    • ipAddress
      Type: string Format: ipv4
    • method
      Type: string
  • user
    Type: object · User

    A user

    • id
      Type: integer Format: int64
      read-only

      Signed 64-bit integers (long type).

    • name
      Type: string