FlowmageDocs

List audiences

BetaReads dataVersion 2

Lists the audiences this Mailchimp account holds.

Settings

SettingWhat it is
ConnectionRequiredThe Mailchimp connection the step signs in with.
Address that is a memberOnly the audiences this address is a contact of.
Created sincetext
Created beforetext
Sent to sinceOnly audiences a campaign went out to after this moment.
Has a webshop"" or "true" or "false"
Sort directionSorts on the date the audience was created.
Fields to fetchMailchimp returns everything unless you name the fields you want. On a page of 1,000 this is the difference between fitting this run's size limit and not.
Audiences per call1 to 1,000.
Skip this manyMailchimp pages by position, not by cursor.
Fetch every pageWalks Mailchimp's pages, and refuses past 5,000 rows rather than answering a short list. Mailchimp pages by position, so a collection that changes while the walk runs can repeat or skip a row.
CursorPaste a previous run's Next cursor to read the page after it.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `mailchimp`)
emailtext
sinceDateCreatedtext
beforeDateCreatedtext
sinceCampaignLastSenttext
hasEcommerceStore"" or "true" or "false"
sortDir"" or "ASC" or "DESC"
fieldstext
limitnumber, by default 100
offsetnumber, by default 0
returnAlltrue/false, by default false
cursortext

Output

FieldType
audiencesarray
audienceCountAudiences in this answernumber
hasMoreMore audiences are waiting behind this pageboolean
totalItemsAudiences in totalnumber
nextCursorCursor for the next pagestring
Sample output, and the expression for each field
  • audienceCount0
  • audiences[]
  • hasMorefalse
  • 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": {
    "beforeDateCreated": "",
    "connection": "<connection id>",
    "cursor": "",
    "email": "",
    "fields": "",
    "hasEcommerceStore": "",
    "limit": 100,
    "offset": 0,
    "returnAll": false,
    "sinceCampaignLastSent": "",
    "sinceDateCreated": "",
    "sortDir": ""
  },
  "label": "List audiences",
  "type": "mailchimp.listAudiences",
  "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.
Address that is a memberOnly the audiences this address is a contact of.
Created sincetext
Created beforetext
Sent to sinceOnly audiences a campaign went out to after this moment.
Has a webshop"" or "true" or "false"
Sort directionSorts on the date the audience was created.
Fields to fetchMailchimp returns everything unless you name the fields you want. On a page of 1,000 this is the difference between fitting this run's size limit and not.
Audiences per call1 to 1,000.
Skip this manyMailchimp pages by position, not by cursor.
Fetch every pageWalks Mailchimp's pages, and refuses past 5,000 rows rather than answering a short list. Mailchimp pages by position, so a collection that changes while the walk runs can repeat or skip a row.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `mailchimp`)
emailtext
sinceDateCreatedtext
beforeDateCreatedtext
sinceCampaignLastSenttext
hasEcommerceStore"" or "true" or "false"
sortDir"" or "ASC" or "DESC"
fieldstext
limitnumber, by default 100
offsetnumber, by default 0
returnAlltrue/false, by default false