FlowmageDocs

List campaign reports

BetaReads dataVersion 2

Lists the delivery reports of sent campaigns.

Settings

SettingWhat it is
ConnectionRequiredThe Mailchimp connection the step signs in with.
Campaign type"" or "regular" or "plaintext" or "absplit" or "rss" or "variate"
Sent sincetext
Sent beforetext
Fields to fetchMailchimp returns everything unless you name the fields you want.
Reports per call1 to 1,000.
Skip this manynumber
Fetch every pageWalks Mailchimp's pages, and refuses past 5,000 rows rather than answering a short list.
CursorPaste a previous run's Next cursor to read the page after it.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `mailchimp`)
type"" or "regular" or "plaintext" or "absplit" or "rss" or "variate"
sinceSendTimetext
beforeSendTimetext
fieldstext
limitnumber, by default 100
offsetnumber, by default 0
returnAlltrue/false, by default false
cursortext

Output

FieldType
reportsarray
reportCountReports in this answernumber
hasMoreMore reports are waiting behind this pageboolean
totalItemsReports in totalnumber
nextCursorCursor for the next pagestring
Sample output, and the expression for each field
  • hasMorefalse
  • reportCount0
  • reports[]
  • totalItems0

Errors

When a step of this node stops a run, the run page shows a code. Look it up:

Example step

The step as a flow file holds it. Replace each value in <…>.

{
  "config": {
    "beforeSendTime": "",
    "connection": "<connection id>",
    "cursor": "",
    "fields": "",
    "limit": 100,
    "offset": 0,
    "returnAll": false,
    "sinceSendTime": "",
    "type": ""
  },
  "label": "List campaign reports",
  "type": "mailchimp.listCampaignReports",
  "version": 2
}

Older versions

A flow that already has this version keeps running it. A new step always gets the newest.

Version 1
SettingWhat it is
ConnectionRequiredThe Mailchimp connection the step signs in with.
Campaign type"" or "regular" or "plaintext" or "absplit" or "rss" or "variate"
Sent sincetext
Sent beforetext
Fields to fetchMailchimp returns everything unless you name the fields you want.
Reports per call1 to 1,000.
Skip this manynumber
Fetch every pageWalks Mailchimp's pages, and refuses past 5,000 rows rather than answering a short list.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `mailchimp`)
type"" or "regular" or "plaintext" or "absplit" or "rss" or "variate"
sinceSendTimetext
beforeSendTimetext
fieldstext
limitnumber, by default 100
offsetnumber, by default 0
returnAlltrue/false, by default false