Skip to navigation
API ReferenceReporting

Get survey report

Get report for a survey.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

OR
AuthorizationBearer
Authorization using OAuth

Path parameters

survey_idstringRequired
The ID of the survey.

Query parameters

fieldslist of stringsOptional

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldslist of stringsOptional

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Response

Survey Report Instance
created_atdatetimeOptionalRead-only
The date and time the survey was created in ISO 8601 format.
idstringOptionalRead-only
A string that uniquely identifies this survey.
list_idstringOptionalRead-only
The ID of the list connected to this survey.
list_namestringOptionalRead-only
The name of the list connected to this survey.
published_atdatetimeOptionalRead-only
The date and time the survey was published in ISO 8601 format.
statusenumOptionalRead-only
The survey's status.
Allowed values:
titlestringOptionalRead-only
The title of the survey.
total_responsesintegerOptionalRead-only
The total number of responses to this survey.
updated_atdatetimeOptionalRead-only
The date and time the survey was last updated in ISO 8601 format.
urlstringOptionalRead-only
The URL for the survey.
web_idintegerOptionalRead-only

The ID used in the Mailchimp web application. View this survey report in your Mailchimp account at https://{dc}.admin.mailchimp.com/lists/surveys/results?survey_id={web_id}.