reporting

List survey responses

Get responses to a survey.

get/3.0/reporting/surveys/{survey_id}/responses

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.

answered_questioninteger

The ID of the question that was answered.

chose_answerstring

The ID of the option chosen to filter responses on.

respondent_familiarity_is'new' | 'known' | 'unknown'

Filter survey responses by familiarity of the respondents.

Response

List of survey responses

total_itemsinteger

The total number of items matching the query regardless of pagination.

Changes

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