Ticker Docs
Tools

list_views

List Saved Views

Reads only.

Use this to list the caller's saved Views and their state. Use list_matches instead for which events entered those Views, and get_view_alert_preview for what one View would send. List the caller's saved Views (a View is a saved Screen: id, name, predicate, enabled, channels, view_url). Each row carries member_count (events matching the screen as of the last pipeline evaluation, 0 for a View created since) and recent_match_count (live matches in the last 7 days), distinct numbers: membership is a set size, matches are entry events. match_count is the View's alert history (matches ever recorded), never its current matches. lock is set when the View filters on a column the owner's plan does not include: it sends no alerts until the owner is on lock.required_tier again or the lock.columns are taken out of its filter; it is never switched off, edited or deleted. Tell the person which plan opens it. Paginated.

Parameters

NameTypeRequiredDefaultNotes
pageinteger1At least 1.
limitinteger20From 1 to 100.
enabledbooleanFilter by enabled state if provided.

Example

{ "enabled": true, "limit": 50 }

On this page