MAmailchimp
reporting

Get survey question report

Get report for a survey question.

get/3.0/reporting/surveys/{survey_id}/questions/{question_id}

Request

Path parameters

survey_idstring required

The ID of the survey.

question_idstring required

The ID of the survey question.

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 Question Report Instance

average_ratingnumber float

The average rating for this range question.

has_otherboolean

Whether this survey question has an 'other' option.

idstring

The ID of the survey question.

is_requiredboolean

Whether this survey question is required to answer.

other_labelstring

Label used for the 'other' option of this survey question.

placeholder_labelstring

Placeholder text for this survey question's answer box.

querystring

The query of the survey question.

range_high_labelstring

Label for the high end of the range.

range_low_labelstring

Label for the low end of the range.

subscribe_checkbox_enabledboolean

Whether the subscribe checkbox is shown for this email question.

subscribe_checkbox_labelstring

Label used for the subscribe checkbox for this email question.

survey_idstring

The unique ID of the survey.

total_responsesinteger

The total number of responses to this question.

type'pickOne' | 'pickMany' | 'range' | 'text' | 'email' | 'contactInformation' | 'dropdown'

The response type of the survey question.

Example response

{
  "average_rating": 2.5,
  "total_responses": 810
}

Changes

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