List Analytics Publications
See a page's publications: who each one sends to, where, and when it sends next. Only the page's owner can list them.
Path
The page id, from List Analytics Pages.
Headers
Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. Here a key acts in another organization only as one of its members: with "Use this key across all of your organizations" on, in an organization its creator belongs to with a role. Child organizations and MindCloud staff access do not reach this endpoint. Every response's X-Company-Id header names the organization it acted in. See Organizations.
Query
RSQL expression used to filter list results.
Maximum number of rows to return.
Number of rows to skip.
Comma-separated sort fields; prefix with - for descending.
Comma-separated response fields to include.
Response fields
idstringThe publication's id.
pageIdstringThe page it sends, from List Analytics Pages.
namestringIts name. Null until one is given.
isActivebooleanTrue when it sends on its schedule. A new publication starts paused.
channelstringWhere it sends.
emailEmail to the recipients, from MindCloud or from a Gmail or Outlook connection.slackA message in a Slack channel, sent with a Slack connection.teamsA message in a Microsoft Teams channel, sent with a Microsoft Teams connection.
scheduleTypestringHow its schedule is set.
fixedOn the weekdays in days, at each time in runTimes.intervalEvery intervalMinutes, starting at the first time in runTimes.monthlyOn the days of the month in monthDays, at each time in runTimes.onceOnce, on the date in runDates, at the time in runTimes.
intervalMinutesnumberFor interval: minutes between sends, 360 (six hours) to 43200 (thirty days).
daysarray of numberFor fixed: the weekdays it sends on, 0 (Sunday) to 6 (Saturday).
monthDaysarray of numberFor monthly: the days of the month it sends on, 1 to 30, or -1 for the last day.
runDatesarray of stringFor once: the date it sends on, as YYYY-MM-DD.
runTimesarray of stringThe times of day it sends at, as HH:MM in timeZone.
timeZonestringThe IANA time zone its times are in, such as America/New_York.
isOrganizationTimeZonebooleanTrue when timeZone is the organization's time zone and changes with it; false when one was set for this publication.
nextRunOndateWhen it sends next. Null while it is paused or has nothing left to send.
autoPausedOndateWhen MindCloud paused it after failed sends. Null when it was not.
autoPauseReasonstringWhy MindCloud paused it. Null when it was not.
recipientUserIdsarray of stringMember recipients, by user id (from List Members).
externalRecipientsarray of stringRecipients outside the organization, by email address.
unsubscribedRecipientUserIdsarray of stringMembers who unsubscribed with the link in its email, by user id. They get nothing until resubscribed.
unsubscribedExternalRecipientsarray of stringOutside addresses that unsubscribed with the link in its email.
subjectstringThe email subject. Null uses the page's name.
connectionIdstringThe connection it sends through, from List Connections. Null for email from MindCloud's own sender.
destinationobjectFor slack and teams: where it posts. Null for email.
channelIdstringSlack and Teams: the channel id it posts in. Null for email.
channelLabelstringSlack and Teams: the channel name, as picked. Null for email.
teamIdstringTeams: the team id. Null otherwise.
teamLabelstringTeams: the team name, as picked. Null otherwise.
variablesobjectIts own filter values, by page variable name, as the page's link carries them. Empty uses the page's defaults.
createdOndateWhen it was created.
updatedOndateWhen it last changed.