Skip to main content
Server path: /mailchimp-reports | Type: Application | PCID required: Yes

Tools

ToolDescription
mailchimp_reports_get_idGet campaign report
mailchimp_reports_get_id_abuse_reports_idList abuse reports
mailchimp_reports_get_id_abuse_reports_id_idGet abuse report
mailchimp_reports_get_id_adviceList campaign feedback
mailchimp_reports_get_id_click_detailsList campaign details
mailchimp_reports_get_id_click_details_idGet campaign link details
mailchimp_reports_get_id_click_details_id_membersList clicked link subscribers
mailchimp_reports_get_id_click_details_id_members_idGet clicked link subscriber
mailchimp_reports_get_id_domain_performanceList domain performance stats
mailchimp_reports_get_id_ecommerce_product_activityList campaign product activity
mailchimp_reports_get_id_eepurlList EepURL activity
mailchimp_reports_get_id_email_activityList email activity
mailchimp_reports_get_id_email_activity_idGet subscriber email activity
mailchimp_reports_get_id_locationsList top open activities
mailchimp_reports_get_id_open_detailsList campaign open details
mailchimp_reports_get_id_open_details_id_members_idGet opened campaign subscriber
mailchimp_reports_get_id_sent_toList campaign recipients
mailchimp_reports_get_id_sent_to_idGet campaign recipient info
mailchimp_reports_get_id_sub_reports_idList child campaign reports
mailchimp_reports_get_id_unsubscribedList unsubscribed members
mailchimp_reports_get_id_unsubscribed_idGet unsubscribed member
mailchimp_reports_get_reporting_facebook_adsList facebook ads reports
mailchimp_reports_get_reporting_facebook_ads_idGet facebook ad report
mailchimp_reports_get_reporting_facebook_ads_id_ecommerce_product_activityList facebook ecommerce report
mailchimp_reports_get_reporting_landing_pagesList landing pages reports
mailchimp_reports_get_reporting_landing_pages_idGet landing page report
mailchimp_reports_get_reporting_surveysList survey reports
mailchimp_reports_get_reporting_surveys_idGet survey report
mailchimp_reports_get_reporting_surveys_id_questionsList survey question reports
mailchimp_reports_get_reporting_surveys_id_questions_idGet survey question report
mailchimp_reports_get_reporting_surveys_id_questions_id_answersList answers for question
mailchimp_reports_get_reporting_surveys_id_responsesList survey responses
mailchimp_reports_get_reporting_surveys_id_responses_idGet survey response
mailchimp_reports_get_reportsList campaign reports

mailchimp_reports_get_id

Get campaign report Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
campaign_idstringYesThe unique id for the campaign.

mailchimp_reports_get_id_abuse_reports_id

List abuse reports Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
campaign_idstringYesThe unique id for the campaign.

mailchimp_reports_get_id_abuse_reports_id_id

Get abuse report Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
campaign_idstringYesThe unique id for the campaign.
report_idstringYesThe id for the abuse report.

mailchimp_reports_get_id_advice

List campaign feedback Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
campaign_idstringYesThe unique id for the campaign.

mailchimp_reports_get_id_click_details

List campaign details Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.
campaign_idstringYesThe unique id for the campaign.
sort_fieldstringNoReturns click reports sorted by the specified field.
sort_dirstringNoDetermines the order direction for sorted results.

mailchimp_reports_get_id_click_details_id

Get campaign link details Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
campaign_idstringYesThe unique id for the campaign.
link_idstringYesThe id for the link.

mailchimp_reports_get_id_click_details_id_members

List clicked link subscribers Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.
campaign_idstringYesThe unique id for the campaign.
link_idstringYesThe id for the link.

mailchimp_reports_get_id_click_details_id_members_id

Get clicked link subscriber Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
campaign_idstringYesThe unique id for the campaign.
link_idstringYesThe id for the link.
subscriber_hashstringYesThe MD5 hash of the lowercase version of the list member’s email address.

mailchimp_reports_get_id_domain_performance

List domain performance stats Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
campaign_idstringYesThe unique id for the campaign.

mailchimp_reports_get_id_ecommerce_product_activity

List campaign product activity Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.
campaign_idstringYesThe unique id for the campaign.
sort_fieldstringNoReturns files sorted by the specified field.

mailchimp_reports_get_id_eepurl

List EepURL activity Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
campaign_idstringYesThe unique id for the campaign.

mailchimp_reports_get_id_email_activity

List email activity Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.
campaign_idstringYesThe unique id for the campaign.
sincestringNoRestrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

mailchimp_reports_get_id_email_activity_id

Get subscriber email activity Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
campaign_idstringYesThe unique id for the campaign.
subscriber_hashstringYesThe MD5 hash of the lowercase version of the list member’s email address.
sincestringNoRestrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

mailchimp_reports_get_id_locations

List top open activities Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
campaign_idstringYesThe unique id for the campaign.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.

mailchimp_reports_get_id_open_details

List campaign open details Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.
campaign_idstringYesThe unique id for the campaign.
sincestringNoRestrict results to campaign open events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
sort_fieldstringNoReturns open reports sorted by the specified field.
sort_dirstringNoDetermines the order direction for sorted results.

mailchimp_reports_get_id_open_details_id_members_id

Get opened campaign subscriber Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
campaign_idstringYesThe unique id for the campaign.
subscriber_hashstringYesThe MD5 hash of the lowercase version of the list member’s email address.

mailchimp_reports_get_id_sent_to

List campaign recipients Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.
campaign_idstringYesThe unique id for the campaign.

mailchimp_reports_get_id_sent_to_id

Get campaign recipient info Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
campaign_idstringYesThe unique id for the campaign.
subscriber_hashstringYesThe MD5 hash of the lowercase version of the list member’s email address.

mailchimp_reports_get_id_sub_reports_id

List child campaign reports Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
campaign_idstringYesThe unique id for the campaign.

mailchimp_reports_get_id_unsubscribed

List unsubscribed members Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.
campaign_idstringYesThe unique id for the campaign.

mailchimp_reports_get_id_unsubscribed_id

Get unsubscribed member Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
campaign_idstringYesThe unique id for the campaign.
subscriber_hashstringYesThe MD5 hash of the lowercase version of the list member’s email address.

mailchimp_reports_get_reporting_facebook_ads

List facebook ads reports Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.
sort_fieldstringNoReturns files sorted by the specified field.
sort_dirstringNoDetermines the order direction for sorted results.

mailchimp_reports_get_reporting_facebook_ads_id

Get facebook ad report Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
outreach_idstringYesThe outreach id.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

mailchimp_reports_get_reporting_facebook_ads_id_ecommerce_product_activity

List facebook ecommerce report Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.
outreach_idstringYesThe outreach id.
sort_fieldstringNoReturns files sorted by the specified field.

mailchimp_reports_get_reporting_landing_pages

List landing pages reports Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.

mailchimp_reports_get_reporting_landing_pages_id

Get landing page report Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
outreach_idstringYesThe outreach id.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

mailchimp_reports_get_reporting_surveys

List survey reports Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.

mailchimp_reports_get_reporting_surveys_id

Get survey report Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
survey_idstringYesThe ID of the survey.

mailchimp_reports_get_reporting_surveys_id_questions

List survey question reports Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
survey_idstringYesThe ID of the survey.

mailchimp_reports_get_reporting_surveys_id_questions_id

Get survey question report Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
survey_idstringYesThe ID of the survey.
question_idstringYesThe ID of the survey question.

mailchimp_reports_get_reporting_surveys_id_questions_id_answers

List answers for question Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
survey_idstringYesThe ID of the survey.
question_idstringYesThe ID of the survey question.
respondent_familiarity_isstringNoFilter survey responses by familiarity of the respondents.

mailchimp_reports_get_reporting_surveys_id_responses

List survey responses Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
survey_idstringYesThe ID of the survey.
answered_questionintegerNoThe ID of the question that was answered.
chose_answerstringNoThe ID of the option chosen to filter responses on.
respondent_familiarity_isstringNoFilter survey responses by familiarity of the respondents.

mailchimp_reports_get_reporting_surveys_id_responses_id

Get survey response Parameters:
ParameterTypeRequiredDefaultDescription
survey_idstringYesThe ID of the survey.
response_idstringYesThe ID of the survey response.

mailchimp_reports_get_reports

List campaign reports Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.
typestringNoThe campaign type.
before_send_timestringNoRestrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
since_send_timestringNoRestrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.