get_view_alert_preview
Preview a View's Alerts
Reads only.
Use this for what one View would have emailed in the last 24 hours. Use list_matches instead for the Matches it recorded and their delivery state. A dry run: replay the last 24 hours of this View's Matches through the real send decision under the owner's CURRENT settings and report what would have been emailed. Nothing is sent and nothing is claimed. Read it after create_view or update_view to tell the person what they just armed. matches is how many the View caught in the window; emails is how many emails those would have produced, which is smaller whenever the View gathers its Matches into an hourly email or a daily email; email_times is when each would have gone. mode is the value instant, digest (Matches gathered into an hourly email or a daily email) or muted. paused true means the account has alert email switched off entirely, so the numbers describe a send that would not happen; the simulation ignores that switch on purpose, so report both. quiet_hours_enabled true means sends inside the owner's quiet hours were moved. lock set means the View filters on a column the owner's plan does not include, so nothing would go out (emails 0) until the owner is on lock.required_tier again. Twenty four hours is the whole window; there is no longer one.
Parameters
| Name | Type | Required | Default | Notes |
|---|---|---|---|---|
view_id | string | yes | The View to preview (from list_views). |