-
See Also
- ServiceExecute
- ServiceConnect
-
- Service Connections
- Mixpanel
-
-
See Also
- ServiceExecute
- ServiceConnect
-
- Service Connections
- Mixpanel
-
See Also
"MailChimp" (Service Connection)
Connecting & Authenticating
Requests
User Subscription Lists
"Lists" — search for available lists and filter them
| "ListID" | None | list with a specific list ID; accepts multiple in a list | |
| "ListName" | None | lists with a specific name | |
| "FromName" | None | lists with a default "FromName" | |
| "FromAddress" | None | lists with a default "FromAddress" | |
| "Subject" | None | lists with a default "Subject" | |
| "CreatedBefore" | None | lists created before this date; accepts DateObject and strings | |
| "CreatedAfter" | None | lists created since this date; accepts DateObject and strings | |
| MaxItems | 10 | number of elements to return | |
| "Exact" | False | whether to use exact values | |
| "StartIndex" | 1 | start index | |
| "SortField" | "Created" | field used for sorting ("Created", "Web") | |
| IgnoreCase | True | whether to ignore cases when using "SortField" |
Members in a Subscription List
"ListMembers" — show members in a list and filter them
| "ListID" | (required) | the ID of the desired list | |
| "Status" | "Subscribed" | show members with a specific status ("Unsubscribed", "Subscribed", or "Cleaned") | |
| MaxItems | 10 | number of elements to return | |
| "StartIndex" | 1 | start index | |
| "SortField" | None | field used for sorting ("Email", "Rating", "LastUpdateTime", or "OptionTime") | |
| IgnoreCase | True | whether to ignore cases when using "SortField" and "Status" |
Abuse Reports from a Subscription List
"ListAbuse" — show members that complained about a campaign sent to a list
| "ListID" | (required) | the ID of the desired list | |
| "StartDate" | None | abuse reports since this date; accepts DateObject and strings | |
| MaxItems | 10 | number of elements to return | |
| "StartIndex" | 1 | start index |
Activity Stats of a Subscription List
"ListActivity" — show daily detailed aggregated activity stats for a given list
| "ListID" | (required) | the ID of the desired list |
Clients Used in a Subscription List
"ListClients" — clients that have been tagged as being used by the list's subscribers
| "ListID" | (required) | the ID of the desired list |
Monthly Growth in a Subscription List
"ListMonthlyGrowth" — growth history by month for a given list
| "ListID" | (required) | the ID of the desired list |
Locations in a Subscription List
"ListLocations" — show locations (countries) of the list's subscribers
| "ListID" | (required) | the ID of the desired list |
User Campaigns
"Campaigns" — search for created campaigns and filter them
| "CampaignID" | None | campaign ID | |
| "ParentID" | None | ID of campaign's parent | |
| "ListID" | None | list ID | |
| "FolderID" | None | folder ID | |
| "TemplateID" | None | template ID | |
| "Status" | None | campaign status ("Sent", "Save", "Paused", "Schedule", "Sending", "Regular") | |
| "Type" | None | campaign type ("Regular", "Plaintext", "ABSplit", "RSS", "Auto") | |
| "FromName" | None | campaign "FromName" | |
| "FromAddress" | None | campaign "FromAddress" | |
| "Title" | None | campaign title | |
| "Subject" | None | campaign subject | |
| "SendTimeStart" | None | earliest send data for campaign (accepts DateObject and strings) | |
| "SendTimeEnd" | None | latest send date for campaign (accepts DateObject and strings) | |
| "UsesSegment" | None | whether to return just campaigns with or without segments | |
| "Exact" | True | whether to use exact values | |
| MaxItems | 10 | number of elements to return | |
| "StartIndex" | 1 | start index | |
| "SortField" | "CreateTime" | sorting field ("CreateTime", "SendTime", "Title", "Subject") | |
| IgnoreCase | True | whether to ignore cases when using "SortField", "Type", and "Status" |
Abuse Reports in a Campaign
"CampaignAbuse" — get a table with all email addresses that complained about a given campaign
| "CampaignID" | (required) | campaign ID | |
| "StartIndex" | 1 | start index | |
| MaxItems | 10 | number of elements to return | |
| "StartDate" | None | only show messages since this date; accepts DateObject and strings |
Clicks on the URLs of a Campaign
"CampaignClicks" — the URLs tracked and their click counts for a given campaign
| "CampaignID" | (required) | campaign ID |
Opens by Country and Region of a Campaign
"CampaignLocations" — retrieve information on the opens of countries/regions in a campaign
| "CampaignID" | (required) | campaign ID |
Summary of a Campaign
"CampaignSummary" — retrieve a summary of campaign statistics
"CampaignSummaryTimeSeries" — some information for the first 24 hours of the campaign
| "CampaignID" | (required) | campaign ID |
Recipients of a Campaign
"CampaignRecipients" — get email addresses to which the campaign was sent
| "CampaignID" | (required) | campaign ID | |
| "StartIndex" | 1 | start index | |
| MaxItems | 10 | number of elements to return | |
| "Status" | None | filter by status ("Sent", "Hard", or "Soft") | |
| IgnoreCase | True | whether to ignore cases when using "Status" |
Emails Opened in a Campaign
"CampaignOpenedBy" — get email addresses that opened a given campaign
| "CampaignID" | (required) | campaign ID | |
| "StartIndex" | 1 | start index | |
| MaxItems | 10 | number of elements to return | |
| "SortField" | "Opened" | sorting field ("Opened" or "Opens") | |
| IgnoreCase | True | whether to ignore cases when using "SortField" |
Emails Not Opened in a Campaign
"CampaignNotOpenedBy" — get email addresses that did not open a given campaign
| "CampaignID" | (required) | campaign ID | |
| "StartIndex" | 1 | start index | |
| MaxItems | 10 | number of elements to return |
Unsubscribed Emails in a Campaign
"CampaignUnsubscriptions" — get all unsubscribed email addresses for a given campaign
| "CampaignID" | (required) | campaign ID | |
| "StartIndex" | 1 | start index | |
| MaxItems | 10 | number of elements to return |
Examples
Basic Examples (1)
Create a new connection by launching an authentication dialog:
Retrieve all the lists defined for your user account:
Review individual entries in a list:
Get a list of available keys from the "Lists" query:
Get a restructured association based on a selected key:
Get a restructured association of the first two items based on a set of selected keys:
Filter lists by a specific "ListID":
Filter lists by creation date:
Access up to the previous 180 days of daily detailed aggregated activity stats for a given list:
Get all email addresses that complained about a campaign sent to a list:
Retrieve the clients that have been tagged as being used by the list's subscribers, based on user agents seen:
Get the list of campaigns and their details matching the specified filters:
Get a quick look at the entries in one of the campaigns:
Get a list of available keys from the "Campaigns" query:
Get a list of the email addresses of the recipients of a campaign:
Retrieve aggregate campaign statistics of a campaign:
Get the open rate of a campaign, or what fraction of delivered campaigns were opened by subscribers:
Get the click rate of a campaign, or how many successfully delivered campaigns registered at least one click: