MAmailchimp
reporting

Get survey report

Get report for a survey.

get/3.0/reporting/surveys/{survey_id}

Request

Path parameters

survey_idstring required

The ID of the survey.

Query parameters

fieldsstring[]

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

exclude_fieldsstring[]

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

Response

Survey Report Instance

created_atstring date-time

The date and time the survey was created in ISO 8601 format.

idstring

A string that uniquely identifies this survey.

list_idstring

The ID of the list connected to this survey.

list_namestring

The name of the list connected to this survey.

published_atstring date-time

The date and time the survey was published in ISO 8601 format.

status'published' | 'unpublished'

The survey's status.

titlestring

The title of the survey.

total_responsesinteger

The total number of responses to this survey.

updated_atstring date-time

The date and time the survey was last updated in ISO 8601 format.

urlstring

The URL for the survey.

web_idinteger

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}.

Example response

{
  "created_at": "2017-08-04T11:09:01+00:00",
  "id": "040d2c2e1f0",
  "published_at": "2017-08-04T11:09:01+00:00",
  "status": "published",
  "title": "New product ideas",
  "total_responses": 810,
  "updated_at": "2017-08-04T11:09:01+00:00",
  "web_id": 165
}

Changes

No recorded changes to this operation across all 1 revision of this API.