TickerDocs
Tools

list_views

Lists your saved Views, whether each is on or paused, how many events each holds, where it delivers and its Digest.

When to use it

  • You want the Views you saved, with their predicates, whether each is on or paused, and where each delivers.
  • You need a view_id for update_view, delete_view or list_matches, or you want one View by its id.
  • You want which events entered your Views: use list_matches. You want what one View would email: use get_view_alert_preview.
  • It replaces list_view_targets and list_digests, whose names still answer: see Old names.

Inputs

  • page (integer, default 1): The page of results.
  • limit (integer, default 20): Views per page. A number above 100 reads as 100.
  • enabled (boolean): Set true for only the Views that are on, false for only the paused ones. Leave it out for both.
  • search (string): Only Views whose name contains this text. Up to 200 characters.
  • tags (array of strings): Only Views that carry any of these tags. Up to 50 items.
  • colors (array of strings): Only Views with any of these colors: red, orange, amber, green, teal, blue, violet or pink. A color not on that list is ignored. Up to 50 items.
  • view_id (uuid): Read this one View instead of a page.

Examples

Which of my Views are paused?

{ "enabled": false }

Show me my Views tagged playoffs.

{ "tags": ["playoffs"], "limit": 100 }

Where does my Knicks playoffs View send its alerts?

{ "view_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7" }

What comes back

  • One row per View, newest first, with id, name, predicate, enabled, channels, notification_mode and view_url, the View's page in Ticker.
  • member_count: the events in the View as of its last run, 0 for a View created since. recent_match_count: the Matches in the last 7 days. match_count: every Match the View ever recorded, not what it holds now.
  • destinations: each destination the View delivers to besides email, with delivery_target_id, label, kind, cadence, last_delivered_at and disabled_at, set when it is paused. A destination's posting URL is never returned.
  • digest: enabled, hour and live when the View has a Digest set, null when it has none. The Digest is an email and a file.
  • lock when the View filters on a column your plan does not include: it sends no alerts until the account is on lock.required_tier again or the lock.columns leave its filter. It stays on and is not changed.
  • total, totalPages, counts of all, active and paused Views, views_cap and locked_count.

Limits and quota

  • Reads only: it changes nothing.
  • Each call spends one MCP request.
  • Lists saved Screens only. A watched event's View is not listed: use list_watchlist.
  • On an organization, you see your own Views and the Views shared with the organization.
  • Views past your plan's Views and stars count are left out of the rows, and the other View tools answer not found for them, until the plan holds more.

On this page