Get survey question report

GET

https://api.mailchimp.com/3.0/reporting/surveys/:survey_id/questions/:question_id

GET

/3.0/reporting/surveys/:survey_id/questions/:question_id

curl https://api.mailchimp.com/3.0/reporting/surveys/survey_id/questions/question_id \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "average_rating": 2.5,
  "contact_counts": {
    "known": 1,
    "new": 1,
    "unknown": 1
  },
  "has_other": true,
  "id": "string",
  "is_required": true,
  "merge_field": {
    "id": 1,
    "label": "string",
    "type": "text"
  },
  "options": [
    {
      "count": 1,
      "id": "string",
      "label": "string"
    }
  ],
  "other_label": "string",
  "placeholder_label": "string",
  "query": "string",
  "range_high_label": "string",
  "range_low_label": "string",
  "subscribe_checkbox_enabled": true,
  "subscribe_checkbox_label": "string",
  "survey_id": "string",
  "total_responses": 810,
  "type": "pickOne"
}

Get report for a survey question.

Authentication

AuthorizationBearer

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

AuthorizationBearer

Authorization using OAuth

Path parameters

survey_idstringRequired

The ID of the survey.

question_idstringRequired

The ID of the survey question.

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

average_ratingfloatOptionalRead-only

The average rating for this range question.

contact_countsobjectOptional

For email question types, how many are new, known, or unknown contacts.

has_otherbooleanOptionalRead-only

Whether this survey question has an 'other' option.

idstringOptionalRead-only

The ID of the survey question.

is_requiredbooleanOptionalRead-only

Whether this survey question is required to answer.

merge_fieldobjectOptionalRead-only

A merge field for an audience.

optionslist of objectsOptionalRead-only

The answer choices for this question.

other_labelstringOptionalRead-only

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

placeholder_labelstringOptionalRead-only

Placeholder text for this survey question's answer box.

querystringOptionalRead-only

The query of the survey question.

range_high_labelstringOptionalRead-only

Label for the high end of the range.

range_low_labelstringOptionalRead-only

Label for the low end of the range.

subscribe_checkbox_enabledbooleanOptionalRead-only

Whether the subscribe checkbox is shown for this email question.

subscribe_checkbox_labelstringOptionalRead-only

Label used for the subscribe checkbox for this email question.

survey_idstringOptionalRead-only

The unique ID of the survey.

total_responsesintegerOptionalRead-only

The total number of responses to this question.

typeenumOptionalRead-only

The response type of the survey question.