ScanAlertSettingsModel

  • alertsEnabled
    Type: boolean
    required

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

  • channels
    Type: object · AlertChannels
    required
    • inapp
      Type: boolean
      required

      Deliver in-app toast while the app is foregrounded

    • push
      Type: boolean
      required

      Deliver remote push notifications (app backgrounded/closed)

  • 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

    • endHour
      Type: integer
      min:  
      0
      max:  
      23
      required

      Hour (0-23) quiet period ends

    • startHour
      Type: integer
      min:  
      0
      max:  
      23
      required

      Hour (0-23) quiet period begins

    • tz
      Type: string
      required

      IANA timezone the start/end hours are evaluated in

  • updatedAt
    Type: string
    required

    ISO timestamp

scanr.ai API