AlertSettingInput

description

Alert setting for saved search

input AlertSettingInput {
  alertFrequency: AlertFrequency
  deliveryTime: DeliveryTimeInput
  streamTypes: [String!]
  limitRealTimeAlerts: Boolean
  groupSimilarDocuments: Boolean
  emailDisplayType: EmailDisplayType
  weekdayOnlyAlert: Boolean
  displaySavedSearchName: Boolean
}

Fields

AlertSettingInput.alertFrequency ● AlertFrequency enum

Email alert frequency

AlertSettingInput.deliveryTime ● DeliveryTimeInput input

Delivery day and Time for Daily and weekly alerts

AlertSettingInput.streamTypes ● [String!] list scalar

Used for routing events to (alert/dashboard/searchFeed) for this saved search. Default is ["alert"] e.g., [alert, dashboard, searchFeed]. Values for what purpose this saved search will be used(dashboard/alert/searchFeed)

AlertSettingInput.limitRealTimeAlerts ● Boolean scalar

Limit alert count to max 100 for real-time frequency. If disabled(false) max alert count will be 1000 for real-time alerts

AlertSettingInput.groupSimilarDocuments ● Boolean scalar

Discard duplicate doc for real time alerts or cluster similar document for daily and weekly email alerts

AlertSettingInput.emailDisplayType ● EmailDisplayType enum

Email template display type

AlertSettingInput.weekdayOnlyAlert ● Boolean scalar

To send email alerts only on weekdays

AlertSettingInput.displaySavedSearchName ● Boolean scalar

If disabled(false) then saved search name will be hidden from email alerts subject

Member of

SavedSearchMutation__create mutation ● SavedSearchMutation__update mutation