Tools
list_watchlist
List Watchlist
Reads only.
Use this for the caller's watched events and the triggers armed on each. Use list_views instead for saved screens. The caller's watched events, with current price/inventory numbers, which triggers are armed on each, and how many alerts each has produced. Watches whose event finished more than a week ago are archived and left out; pass include_archived to see them too. An archived watch carries archived_at, no longer alerts, and accepts no edit.
Parameters
| Name | Type | Required | Default | Notes |
|---|---|---|---|---|
page | integer | 1 | At least 1. | |
limit | integer | 50 | From 1 to 100. | |
search | string | Filter by event name. | ||
sort | string | created_at | One of created_at, utc_date, last_matched_at, event_name. | |
order | string | desc | One of asc, desc. | |
include_archived | boolean | false | Also return watches archived because their event finished more than a week ago. |