Skip to main content

notificationsList

Returns the account's notification rules for goal conversions, survey responses, and site errors, newest first by default, skipping deleted rules and sites the caller cannot access. Page by passing nextPageCursor back as cursor; hasNextPage only means this page was full. Requires notifications navigation access.

notificationsList(
  cursor: String
  limit: Int
  siteId: Int
  resource: NotificationResource
  resourceId: String
  order: NotificationsListOrder
  search: String
  type: ChannelType
): NotificationsListMeta

Arguments​

notificationsList.cursor ● String scalar​

Opaque nextPageCursor from notificationsList; omit for the first page.

notificationsList.limit ● Int scalar​

Page size from 1 to 200; defaults to 25.

notificationsList.siteId ● Int scalar​

Site id from sites; omit to include all sites visible to the caller.

notificationsList.resource ● NotificationResource enum​

Only return rules for this resource type; combine with resourceId to target one resource.

notificationsList.resourceId ● String scalar​

Resource id as a string: goal id from goalCardList, survey id from addonList, or site id from sites.

notificationsList.order ● NotificationsListOrder input​

Sort descriptor; defaults to creation time descending.

Substring match on goal or survey name, Errors on <site name>, resource type, channel type, or destination; * matches any characters.

notificationsList.type ● ChannelType enum​

Optional delivery channel type filter.

Type​

NotificationsListMeta object​

Cursor-based notification list payload. The cursor is derived from ids already seen, and has_next_page only indicates whether the current page reached the requested limit.