List notifications
pushengage_list_notificationsList push notifications on your site, newest first, with filters for status, tags, and date range. Review past or scheduled sends, retrieve notification IDs, and optionally include delivery analytics and goal conversions.
Instructions
Lists push notifications on the current site, newest first, paginated (response includes has_more). Use this to discover notification IDs and review past or upcoming sends. Set include_analytics=true only when the user asks for stats — it costs an extra lookup and adds rolled-up counts and goal conversions to each row. Each item carries content, status, targeting criteria, and delivery stats; the criteria.audience_groups ids are reusable as the send tools' audience_groups input, and absent criteria means the notification went to all subscribers.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number (1-indexed) for paginating beyond the first batch. | |
| tags | No | Only notifications carrying at least one of these tags (up to 5). | |
| limit | No | How many notifications to return in this page. Min 1, max 100, default 10. To browse past the first 100, increase `page` instead of asking for a larger limit. | |
| status | No | Filter by status, matching the dashboard tabs: "sent" (includes currently sending), "scheduled" (includes active and paused recurring notifications), "draft" (includes archived). "all" (default) returns every status. | all |
| site_id | No | Override the currently selected site | |
| sent_after | No | Only notifications sent on or after this date (YYYY-MM-DD, site timezone). Must be 2017-07-01 or later, and must be paired with sent_before. | |
| sent_before | No | Only notifications sent on or before this date (YYYY-MM-DD, site timezone). Must be paired with sent_after and be on or after it. | |
| exclude_tags | No | Exclude notifications carrying any of these tags (up to 5). | |
| include_analytics | No | When true, merge in full delivery analytics (A/B variant totals and subscriber-timezone child sends roll up into the parent row) and goal conversions (goal_count/goal_value per row). Costs extra lookups; only set it when the user asks for stats/performance. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| limit | No | ||
| total | No | ||
| has_more | No | ||
| last_page | No | ||
| notifications | No |