SurveyResponse Returned Fields v5

Returned fields for the SurveyResponse object are explained below. Go to the Example Returns section to view return examples for each call type.

Returned Fields for the SurveyResponse Object

FieldDescriptionFormat
idResponse IDstring
statusComplete, Partial, Disqualifiedstring
contact_idEmail Campaign Contact IDstring
is_test_dataTest data flagboolean
date_submitted (EST/EDT or GMT -5/GMT -4)Date/time response was submittedYYYY-MM-DD HH:MM:SS
session_idUnique session ID generated for each responsestring
languageLanguage in which survey was takenstring
date_started (EST/EDT or GMT -5/GMT -4)Date/time response was startedYYYY-MM-DD HH:MM:SS
link_idID of the survey share linkstring
url_variablesURL variable valuearray
ip_addressIP address valuestring
refererReferer valuestring
user_agentUser Agent valuestring
response_timeISP Datastring
data_qualityData Cleaning Tool Response Flagsstring/numeric
commentsISP datastring
longitudeLongitudestring
latitudeLatitudestring
countryCountrystring
cityCitystring
regionRegionstring
postalPostal codestring
dmaISP Datastring
survey_data[id]Question IDnumeric
survey_data[type]Question Typestring
survey_data[question]Question Titlestring
survey_data[section_id]Page IDnumeric
survey_data[answer]Selected Answerstring
survey_data[answer_id]
Selected Answer Option ID
number
survey_data[shown]Indicates whether given question ID was shownboolean
subquestions[id]Sub Question IDnumeric
subquestions[type]Sub Question Typestring
subquestions[parent]Parent Question IDnumeric
subquestions[question]Sub Question Titlestring
subquestions[shown]Indicates whether given sub-question ID was shownstring
subquestions[answer]Sub Question Answerstring
options[id]Answer Option IDnumeric
options[option]Answer Option Reporting Valuestring

*Check out the SurveyResponse Return Per Question Type Document for more specifics on how each question type returns.

Example Returns (.debug format)

GetList Return Example (.debug format):

Array
(
[result_ok] => 1
[total_count] => 2
[page] => 1
[total_pages] => 1
[results_per_page] => 50
[data] => Array
(
[0] => Array
(
[id] => 1
[contact_id] =>
[status] => Complete
[is_test_data] => 0
[date_submitted] => 2013-09-09 15:18:45
[SessionID] => 123456_12abc12345.12345
[Language] => English
[date_started] => 2016-01-22 13:18:24
[link_id] =>
[url_variables] => Array
(
)

[ip_address] => 10.142.2.98
[referer] =>
[user_agent] => Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.106 Safari/537.36
[response_time] =>
[data_quality] => Array
(
)

[comments] =>
[longitude] =>
[latitude] =>
[country] =>
[city] =>
[region] =>
[postal] =>
[dma] =>
[survey_data] => Array
(
[2] => Array
(
[id] => 2
[type] => RADIO
[question] => Will you be attending the event?
[section_id] => 1
[answer] => Yes
[shown] => 1
)

[3] => Array
(
[id] => 3
[type] => MENU
[question] => How many guests will you be bringing?
[section_id] => 1
[answer] => 3
[shown] => 1
)

[7] => Array
(
[id] => 7
[type] => MENU
[question] => How many guests are under 18?
[section_id] => 1
[shown] => 1
[answer] => 1
)

)

)

)

)

GetSurveyResponse Return Example (.debug format):

Array
(
[result_ok] => 1
[data] => Array
(
[id] => 2
[contact_id] =>
[status] => Complete
[is_test_data] => 0
[date_submitted] => 2016-01-22 13:18:24 EST
[session_id] => 1453486704_56a2727029a583.95611886
[language] => English
[date_started] => 2016-01-22 13:18:24 EST
[link_id] =>
[url_variables] => Array
(
)

[ip_address] => 10.142.2.98
[referer] =>
[user_agent] => Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.106 Safari/537.36
[response_time] =>
[data_quality] => Array
(
)

[comments] =>
[longitude] =>
[latitude] =>
[country] =>
[city] =>
[region] =>
[postal] =>
[dma] =>
[survey_data] => Array
(
[2] => Array
(
[id] => 2
[type] => RADIO
[question] => Will you be attending the event?
[section_id] => 1
[answer] => Yes
[shown] => 1
)

[3] => Array
(
[id] => 3
[type] => MENU
[question] => How many guests will you be bringing?
[section_id] => 1
[answer] => 2
[shown] => 1
)

[7] => Array
(
[id] => 7
[type] => MENU
[question] => How many guests under the age of 18?
[section_id] => 1
[shown] => 1
[answer] => 1
)

Create SurveyResponse Return Example (.debug format):

Array
(
[result_ok] => 1
[data] => Array
(
[id] => 3125
[contact_id] =>
[status] => Complete
[is_test_data] => 0
[date_submitted] => 2016-06-02 12:25:49 EDT
[session_id] => 1464884749_57505e0d013c65.36697260
[language] => English
[date_started] => 2016-06-02 12:25:49 EDT
[link_id] =>
[url_variables] => Array
(
)

[ip_address] => 10.142.2.20
[referer] =>
[user_agent] => SurveyGizmo REST API
[response_time] =>
[data_quality] => Array
(
)

[comments] =>
[longitude] =>
[latitude] =>
[country] =>
[city] =>
[region] =>
[postal] =>
[dma] =>
[survey_data] => Array
(
[2] => Array
(
[id] => 2
[type] => RADIO
[question] => Will you be attending the event?
[section_id] => 1
[answer] => Yes
[shown] => 1
)

)

)

)

Update SurveyResponse Return Example (.debug format):

Array
(
[result_ok] => 1
[data] => Array
(
[id] => 3125
[contact_id] =>
[status] => Complete
[is_test_data] => 0
[date_submitted] => 2016-06-02 12:25:49 EDT
[session_id] => 1464884749_57505e0d013c65.36697260
[language] => English
[date_started] => 2016-06-02 12:25:49 EDT
[link_id] =>
[url_variables] => Array
(
)

[ip_address] => 10.142.2.20
[referer] =>
[user_agent] => SurveyGizmo REST API
[response_time] =>
[data_quality] => Array
(
)

[comments] =>
[longitude] =>
[latitude] =>
[country] =>
[city] =>
[region] =>
[postal] =>
[dma] =>
[survey_data] => Array
(
[2] => Array
(
[id] => 2
[type] => RADIO
[question] => Will you be attending the event?
[section_id] => 1
[answer] => No
[shown] => 1
)

)

)

)

Delete SurveyResponse Return Example (.debug format):

Array
(
[result_ok] => 1
)