FlowmageDocs

List interest categories

BetaReads dataVersion 2

Reads the groups an audience offers, such as Topics or Preferences.

Settings

SettingWhat it is
ConnectionRequiredThe Mailchimp connection the step signs in with.
Audience idPicked from the list Mailchimp offers.
Only this kindHow the group is drawn on the sign-up form.
Sort on"" or "name" or "display_order"
Sort direction"" or "ASC" or "DESC"
Fields to fetchMailchimp returns everything unless you name the fields you want.
Categories 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`)
audienceIdtexta value from the vendor's own list
type"" or "checkboxes" or "dropdown" or "radio" or "hidden"
sortField"" or "name" or "display_order"
sortDir"" or "ASC" or "DESC"
fieldstext
limitnumber, by default 100
offsetnumber, by default 0
returnAlltrue/false, by default false
cursortext

Output

FieldType
categoriesInterest categoriesarray
categoryCountCategories in this answernumber
hasMoreMore are waiting behind this pageboolean
totalItemsCategories in totalnumber
nextCursorCursor for the next pagestring
Sample output, and the expression for each field
  • categories[]
  • categoryCount0
  • 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": {
    "audienceId": "",
    "connection": "<connection id>",
    "cursor": "",
    "fields": "",
    "limit": 100,
    "offset": 0,
    "returnAll": false,
    "sortDir": "",
    "sortField": "",
    "type": ""
  },
  "label": "List interest categories",
  "type": "mailchimp.listInterestCategories",
  "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.
Audience idPicked from the list Mailchimp offers.
Only this kindHow the group is drawn on the sign-up form.
Sort on"" or "name" or "display_order"
Sort direction"" or "ASC" or "DESC"
Fields to fetchMailchimp returns everything unless you name the fields you want.
Categories 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`)
audienceIdtexta value from the vendor's own list
type"" or "checkboxes" or "dropdown" or "radio" or "hidden"
sortField"" or "name" or "display_order"
sortDir"" or "ASC" or "DESC"
fieldstext
limitnumber, by default 100
offsetnumber, by default 0
returnAlltrue/false, by default false