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
| Field | Description | Format |
|---|---|---|
| id | Response ID | string |
| status | Complete, Partial, Disqualified | string |
| contact_id | Email Campaign Contact ID | string |
| is_test_data | Test data flag | boolean |
| datesubmitted (EST/EDT or GMT -5/GMT -4) | Date/time response was submitted | YYYY-MM-DD HH:MM:SS |
| SessionID | Unique session ID generated for each response | string |
| Language | Language in which survey was taken | string |
| datestarted (EST/EDT or GMT -5/GMT -4) | Date/time response was started | YYYY-MM-DD HH:MM:SS |
| iLinkID | ID of the survey share link | string |
| sResponseComment | Individual Response Comment | string |
| responseID | Response ID | string |
| [[question(ID), option(SKU)]]* | Reporting values selected for select questions | string |
| [[question(ID)]]* | Text response for open-text questions | string |
| [[url("VARIABLE")]] | URL variable value | array |
| [[variable(\"ID-shown"\]] | Indicates whether given question ID was shown | boolean |
| [[variable(\"STANDARD_IP"\]] | IP address | string |
| [[variable(\"STANDARD_LONG"\]] | Longitude | string |
| [[variable(\"STANDARD_LAT"\]] | Longitude | string |
| [[variable(\"STANDARD_GEOCOUNTRY"\]] | Country | string |
| [[variable(\"STANDARD_GEOCITY"\]] | City | string |
| [[variable(\"STANDARD_GEOREGION"\]] | Region | string |
| [[variable(\"STANDARD_GEOPOSTAL"\]] | Postal code | string |
| [[variable(\"STANDARD_RESPONSETIME"\]] | ISP Data | string |
| [[variable(\"STANDARD_COMMENTS"\]] | ISP Data | string |
| [[variable("STANDARD_DATAQUALITYCOUNTER")]] | Data Cleaning Tool Response Flag | string |
| [[variable("STANDARD_CHECKBOXONE_COUNT")]] | Data Cleaning Tool Response Flag | numeric |
| [[variable("STANDARD_CHECKBOXONE")]] | Data Cleaning Tool Response Flag | string |
| [[variable("STANDARD_STRAIGHTLINING_COUNT")]] | Data Cleaning Tool Response Flag | numeric |
| [[variable("STANDARD_STRAIGHTLINING")]] | Data Cleaning Tool Response Flag | string |
| [[variable("STANDARD_OPENTEXTGIBBERISH_COUNT")]] | Data Cleaning Tool Response Flag | numeric |
| [[variable("STANDARD_OPENTEXTGIBBERISH")]] | Data Cleaning Tool Response Flag | string |
| [[variable("STANDARD_OPENTEXTBADWORDS_COUNT")]] | Data Cleaning Tool Response Flag | numeric |
| [[variable("STANDARD_OPENTEXTBADWORDS")]] | Data Cleaning Tool Response Flag | string |
| [[variable("STANDARD_OPENTEXTONEWORDREQUIREDESSAY_COUNT")]] | Data Cleaning Tool Response Flag | numeric |
| [[variable("STANDARD_OPENTEXTONEWORDREQUIREDESSAY")]] | Data Cleaning Tool Response Flag | string |
| [[variable("STANDARD_CHECKBOXALL_COUNT")]] | Data Cleaning Tool Response Flag | numeric |
| [[variable("STANDARD_CHECKBOXALL")]] | Data Cleaning Tool Response Flag | string |
| [[variable("STANDARD_AVGQUESTSECONDS")]] | Data Cleaning Tool Response Flag | numeric |
| [[variable("STANDARD_FINGERPRINT")]] | Data Cleaning Tool Response Flag | string |
| [[variable(\"STANDARD_GEODMA"\]] | ISP Data | string |
| [[variable(\"STANDARD_REFERER"\]] | Referer | string |
| [[variable(\"STANDARD_USERAGENT"\]] | User agent | string |
*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
- Get SurveyResponse Return Example
- Create SurveyResponse Return Example
- Update SurveyResponse Return Example
- Delete SurveyResponse Return Example
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
[datesubmitted] => 2013-09-09 15:18:45
[sResponseComment] =>
[responseID] => 1
[[question(2)]] => Yes
[[question(3), option(10003)]] => Cats
[[question(3), option(10004)]] => Dogs
[[question(5), option(10011)]] => 9
[[question(5), option(10012)]] => 8
[[question(5), option(10013)]] => 9
[[question(5), option(10014)]] => 10
[[question(6)]] => 4
[[question(7)]] => I had a wonderful experience with Julie!
[[question(8)]] => Yes
[[question(10)]] =>
[[question(10), question_pipe(1)]] => bri
[[question(11)]] =>
[[question(11), question_pipe(1)]] => hillmer
[[question(20)]] =>
[[question(20), question_pipe(1)]] => soceress@sgizmo.com
[[question(21)]] =>
[[question(21), question_pipe(1)]] => 7204962313
[[variable("STANDARD_IP")]] => 209.210.169.194
[[variable("STANDARD_LONG")]] => -105.270599
[[variable("STANDARD_LAT")]] => 40.014999
[[variable("STANDARD_GEOCOUNTRY")]] => United States
[[variable("STANDARD_GEOCITY")]] => Boulder
[[variable("STANDARD_GEOREGION")]] => CO
[[variable("STANDARD_GEOPOSTAL")]] =>
[[variable("STANDARD_RESPONSETIME")]] =>
[[variable("STANDARD_COMMENTS")]] =>
[[variable("STANDARD_GEODMA")]] => 751
[[variable("STANDARD_REFERER")]] =>
[[variable("STANDARD_USERAGENT")]] => Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/29.0.1547.65 Safari/537.36
[[variable("PORTAL_RELATIONSHIP")]] =>
[[variable("1-shown")]] => 1
[[variable("2-shown")]] => 1
[[variable(2)]] => 10001
[[variable("3-shown")]] => 1
[[variable("5-shown")]] => 1
[[variable("6-shown")]] => 1
[[variable(6)]] => 10018
[[variable("7-shown")]] => 1
[[variable("8-shown")]] => 1
[[variable(8)]] => 10020
[[variable("10-shown")]] => 1
[[variable("10-shown"), question_pipe(1)]] => 1
[[variable("11-shown")]] => 1
[[variable("11-shown"), question_pipe(1)]] => 1
[[variable("20-shown")]] => 1
[[variable("20-shown"), question_pipe(1)]] => 1
[[variable("21-shown")]] => 1
[[variable("21-shown"), question_pipe(1)]] => 1
[[variable("25-shown")]] =>
)
)
)
GetSurveyResponse Return Example (.debug format):
Array
(
[result_ok] => 1
[data] => Array
(
[id] => 1
[contact_id] =>
[status] => Complete
[is_test_data] => 0
[date_submitted] => 2013-09-09 15:18:45
[sResponseComment] =>
[responseID] => 1
[[question(2)]] => Yes
[[question(3), option(10003)]] => Cats
[[question(3), option(10004)]] => Dogs
[[question(5), option(10011)]] => 9
[[question(5), option(10012)]] => 8
[[question(5), option(10013)]] => 9
[[question(5), option(10014)]] => 10
[[question(6)]] => 4
[[question(7)]] => I had a wonder experience with Julie!
[[question(8)]] => Yes
[[question(10)]] =>
[[question(10), question_pipe(1)]] => bri
[[question(11)]] =>
[[question(11), question_pipe(1)]] => hillmer
[[question(20)]] =>
[[question(20), question_pipe(1)]] => soceress@sgizmo.com
[[question(21)]] =>
[[question(21), question_pipe(1)]] => 7204962313
[[variable("STANDARD_IP")]] => 209.210.169.194
[[variable("STANDARD_LONG")]] => -105.270599
[[variable("STANDARD_LAT")]] => 40.014999
[[variable("STANDARD_GEOCOUNTRY")]] => United States
[[variable("STANDARD_GEOCITY")]] => Boulder
[[variable("STANDARD_GEOREGION")]] => CO
[[variable("STANDARD_GEOPOSTAL")]] =>
[[variable("STANDARD_RESPONSETIME")]] =>
[[variable("STANDARD_COMMENTS")]] =>
[[variable("STANDARD_GEODMA")]] => 751
[[variable("STANDARD_REFERER")]] =>
[[variable("STANDARD_USERAGENT")]] => Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/29.0.1547.65 Safari/537.36
[[variable("PORTAL_RELATIONSHIP")]] =>
[[variable("1-shown")]] => 1
[[variable("2-shown")]] => 1
[[variable(2)]] => 10001
[[variable("3-shown")]] => 1
[[variable("5-shown")]] => 1
[[variable("6-shown")]] => 1
[[variable(6)]] => 10018
[[variable("7-shown")]] => 1
[[variable("8-shown")]] => 1
[[variable(8)]] => 10020
[[variable("10-shown")]] => 1
[[variable("10-shown"), question_pipe(1)]] => 1
[[variable("11-shown")]] => 1
[[variable("11-shown"), question_pipe(1)]] => 1
[[variable("20-shown")]] => 1
[[variable("20-shown"), question_pipe(1)]] => 1
[[variable("21-shown")]] => 1
[[variable("21-shown"), question_pipe(1)]] => 1
[[variable("25-shown")]] =>
)
)
Create SurveyResponse Return Example (.debug format):
Array
(
[result_ok] => 1
[data] => Array
(
[id] => 11
[contact_id] =>
[status] => Complete
[is_test_data] => 0
[date_submitted] => 2013-09-09 20:04:09
[sResponseComment] =>
[responseID] => 11
[[question(2)]] => Yes
[[question(3), option(10003)]] => Dog
[[question(3), option(10004)]] =>
[[question(3), option(10006)]] => Other
[[question(5), option(10011)]] => 9
[[question(5), option(10012)]] =>
[[question(5), option(10013)]] =>
[[question(5), option(10014)]] =>
[[question(6)]] => Satisfied
[[question(7)]] => Excellent service!
[[question(8)]] => No
[[question(10)]] =>
[[question(10), question_pipe(1)]] =>
[[question(11)]] =>
[[question(11), question_pipe(1)]] =>
[[question(20)]] =>
[[question(20), question_pipe(1)]] =>
[[question(21)]] =>
[[question(21), question_pipe(1)]] =>
[[variable("STANDARD_IP")]] =>
[[variable("STANDARD_LONG")]] =>
[[variable("STANDARD_LAT")]] =>
[[variable("STANDARD_GEOCOUNTRY")]] =>
[[variable("STANDARD_GEOCITY")]] =>
[[variable("STANDARD_GEOREGION")]] =>
[[variable("STANDARD_GEOPOSTAL")]] =>
[[variable("STANDARD_RESPONSETIME")]] =>
[[variable("STANDARD_COMMENTS")]] =>
[[variable("STANDARD_GEODMA")]] => 751
[[variable("STANDARD_REFERER")]] =>
[[variable("STANDARD_USERAGENT")]] => SurveyGizmo REST API
[[variable("PORTAL_RELATIONSHIP")]] =>
[[variable("1-shown")]] =>
[[variable("2-shown")]] =>
[[variable(2)]] => 10001
[[variable("3-shown")]] =>
[[variable("5-shown")]] =>
[[variable("6-shown")]] =>
[[variable(6)]] => 10018
[[variable("7-shown")]] =>
[[variable("8-shown")]] =>
[[variable(8)]] => 10021
[[variable("10-shown")]] =>
[[variable("10-shown"), question_pipe(1)]] =>
[[variable("11-shown")]] =>
[[variable("11-shown"), question_pipe(1)]] =>
[[variable("20-shown")]] =>
[[variable("20-shown"), question_pipe(1)]] =>
[[variable("21-shown")]] =>
[[variable("21-shown"), question_pipe(1)]] =>
[[variable("25-shown")]] =>
)
)
Update SurveyResponse Return Example (.debug format):
Array
(
[result_ok] => 1
[data] => Array
(
[id] => 11
[contact_id] =>
[status] => Complete
[is_test_data] => 0
[date_submitted] => 2013-09-09 20:04:09
[sResponseComment] =>
[responseID] => 11
[[question(2)]] => Yes
[[question(3), option(10003)]] => Dog
[[question(3), option(10004)]] => Cat
[[question(3), option(10006)]] => Other
[[question(5), option(10011)]] => 9
[[question(5), option(10012)]] => 10
[[question(5), option(10013)]] => 8
[[question(5), option(10014)]] => 9
[[question(6)]] => Very Satisfied
[[question(7)]] => Excellent service!
[[question(8)]] => No
[[question(10)]] =>
[[question(10), question_pipe(1)]] =>
[[question(11)]] =>
[[question(11), question_pipe(1)]] =>
[[question(20)]] =>
[[question(20), question_pipe(1)]] =>
[[question(21)]] =>
[[question(21), question_pipe(1)]] =>
[[variable("STANDARD_IP")]] =>
[[variable("STANDARD_LONG")]] =>
[[variable("STANDARD_LAT")]] =>
[[variable("STANDARD_GEOCOUNTRY")]] =>
[[variable("STANDARD_GEOCITY")]] =>
[[variable("STANDARD_GEOREGION")]] =>
[[variable("STANDARD_GEOPOSTAL")]] =>
[[variable("STANDARD_RESPONSETIME")]] =>
[[variable("STANDARD_COMMENTS")]] =>
[[variable("STANDARD_GEODMA")]] => 751
[[variable("STANDARD_REFERER")]] =>
[[variable("STANDARD_USERAGENT")]] => SurveyGizmo REST API
[[variable("PORTAL_RELATIONSHIP")]] =>
[[variable("1-shown")]] =>
[[variable("2-shown")]] =>
[[variable(2)]] => 10001
[[variable("3-shown")]] =>
[[variable("5-shown")]] =>
[[variable("6-shown")]] =>
[[variable(6)]] => 10018
[[variable("7-shown")]] =>
[[variable("8-shown")]] =>
[[variable(8)]] => 10021
[[variable("10-shown")]] =>
[[variable("10-shown"), question_pipe(1)]] =>
[[variable("11-shown")]] =>
[[variable("11-shown"), question_pipe(1)]] =>
[[variable("20-shown")]] =>
[[variable("20-shown"), question_pipe(1)]] =>
[[variable("21-shown")]] =>
[[variable("21-shown"), question_pipe(1)]] =>
[[variable("25-shown")]] =>
)
)
Delete SurveyResponse Return Example (.debug format):
Array
(
[result_ok] => 1
)