get_respondent_list

POST : get_respondent_list

Details

Retrieves a paged list of respondents for a given survey and optionally collector


Notes

  • Surveys with over 500,000 respondents will not be returned
  • DateStrings must be in the format YYYY-MM-DD HH:MM:SS. All DateStrings are implicitly in UTC.
  • All start dates are greater than or equal to the date passed in
  • All end dates are strictly less than date passed in
  • Basic users will only have the first 100 respondents returned and will have the upgrade_info dictionary

Endpoint


Request Data

Name Description Return Type
survey_id
(Required)
Survey Id String
collector_id
(Optional)
Collector_id String
page
(Optional)
Page number. Defaults to 1 Integer
page_size
(Optional)
Number of surveys to return per page. Defaults to 1000 for paid users, 100 for basic users. Integer
start_date
(Optional)
Respondents must be created after this date DateString
end_date
(Optional)
Respondents must be created before this date DateString
start_modified_date
(Optional)
Respondents must be modified after this date DateString
end_modified_date
(Optional)
Respondents must be modified before this date DateString
order_asc
(Optional)
If 'true' sorts ASC, if 'false' sorts DESC. Defaults to 'false' (DESC). Boolean
order_by
(Optional)
Column to sort results by. Defaults to respondent_id one of the following: [respondent_id, date_modified, date_start]
fields
(Optional)
Additional fields to return. One or more of :[date_start, date_modified, collector_id, collection_mode, custom_id, email, first_name, last_name, ip_address, status, analysis_url] Array

Response Fields

Name Description Return Type
status
(Required)
Status code returned with every response Integer
data.page
(Required)
Page id Integer
data.page_size
(Required)
Page size Integer
data.respondents[_].respondent_id
(Required)
Respondent Id String
data.respondents[_].date_start
(Optional)
Date the respondent started answering survey Date String
data.respondents[_].date_modified
(Optional)
Date respondent last modified their responses Date String
data.respondents[_].collector_id
(Optional)
Collector Id String
data.respondents[_].collection_mode
(Optional)
Way the respondent answered String-ENUM
data.respondents[_].custom_id
(Optional)
Custom id set by client String
data.respondents[_].email
(Optional)
Email address for respondent String
data.respondents[_].first_name
(Optional)
First name of respondent String
data.respondents[_].last_name
(Optional)
Last name of the respondent String
data.respondents[_].ip_address
(Optional)
IP address of respondent String
data.respondents[_].status
(Optional)
Status of respondent in survey String-ENUM
data.respondents[_].analysis_url
(Optional)
Url to analysis page String
upgrade_info.restrictions[_].message
(Optional)
Message present for any restrictions with the request String
upgrade_info.restrictions[_].code
(Optional)
Code for the restriction Integer
upgrade_info.upgrade_url
(Optional)
Upgrade url that can help a user remove the restriction String

Example Request

curl -H 'Authorization:bearer XXXYYYZZZ' -H 'Content-Type: application/json' https://api.surveymonkey.net/v2/surveys/get_respondent_list?api_key=your_api_key --data-binary '{"survey_id":"100399456", "collector_id":"23907195", "fields":["first_name", "date_start", "date_modified", "custom_id", "analysis_url"], "page_size":5, "page":1, "start_date":"2013-02-04 23:25:09"}'

Last updated August 07, 2013