GetAlertSettingsResponse

  • settings
    Type: array object[] · ScanAlertSettingsModel[]
    required

    The user's per-scan alert settings

    • alertsEnabled
      Type: boolean
      required

      Master opt-in. Defaults false — a scan is silent until enabled

    • channels
      Type: object · AlertChannels
      required
    • cooldownMinutes
      Type: integer | null
      min:  
      0
      required

      Minimum minutes between alerts for this scan. NULL => use the code default

    • createdAt
      Type: string
      required

      ISO timestamp

    • leviathanId
      Type: integer
      required

      The scan this config applies to (== saved_scan.leviathan_id)

    • minNewTickers
      Type: integer | null
      min:  
      1
      required

      Only alert when this many new tickers appear. NULL => use the code default

    • quietHours
      Type: object | null · AlertQuietHours
      required

      Window during which push is suppressed, or null for none

    • updatedAt
      Type: string
      required

      ISO timestamp

scanr.ai API