Returned fields for the Survey object are explained below. Go to the Example Returns section to view return examples for each call type.
Returned Fields for the Survey Object
| Field | Description | Format |
|---|---|---|
| id | Survey ID | string |
| team | Team ID | string |
| _type | API object type | string |
| _subtype | Project type (Survey, Poll, Form, Quiz) | string |
| Status | Project status (Open, Closed) | string |
| created_on | Date/time created | YYYY-MM-DD HH:MM:SS |
| modified_on | Date/time last modified | YYYY-MM-DD HH:MM:SS |
| forward_only | Disables Back Button | boolean |
| languages | Array of translated languages | string |
| title | Project/Survey Title | string |
| internal_title | Internal Title | string |
| title_ml | Array of titles for each translation (ex: [English] => Survey Title, [Spanish] =>Encuesta Título) | string |
| Links | Array of all share links | URL |
| Statistics | Array of response counts for each status e.g. partial, complete, etc. | array |
| theme | Theme ID | string |
| blockby | Duplicate protection type (IP, COOKIE, null) | string |
| pages | Array of survey pages. See SurveyPage Returned Fields for more info. | array |
Example Returns (.debug format)
- GetList Return Example
- Get Survey Return Example
- Create Survey Return Example
- Update Survey Return Example
- Delete Survey Return Example
GetList Return Example (.debug format):
Array
(
[result_ok] => 1
[total_count] => 5
[page] => 1
[total_pages] => 1
[results_per_page] => 5
[data] => Array
(
[0] => Array
(
[id] => 1357785
[team] => 406258
[_type] => Survey
[_subtype] => Poll
[status] => Launched
[created_on] => 2013-09-07 19:55:22
[modified_on] => 2013-09-07 19:55:23
[title] => Poll
[statistics] =>
(
[Complete] => 2
)
[links] => Array
(
[edit] => {edit link}
[publish] => {publish link}
)
)
)
)GetSurvey Return Example (.debug format):
Array
(
[result_ok] => 1
[data] => Array
(
[id] => 1118412
[team] => 406257
[_type] => Survey
[_subtype] => Survey
[status] => In Design
[created_on] => 2012-12-18 17:19:23
[modified_on] => 2012-12-19 16:05:49
[forward_only] =>
[languages] => Array
(
[0] => English
)
[title] => Survey
[internal_title] => Survey
[title_ml] => Array
(
[English] => Survey
)
[theme] => 11147
[blockby] => NONE
[statistics] =>
[links] => Array
(
[edit] => {edit link}
[publish] => {publish link}
)
The remainder of the survey get object return is an array of survey pages. See the SurveyPage object for more.Create Survey Return Example (.debug format):
Array
(
[result_ok] => 1
[data] => Array
(
[id] => 1120173
[team] => 406256
[_type] => Survey
[_subtype] => Survey
[status] => In Design
[created_on] => 2012-12-20 16:03:16
[modified_on] => 2012-12-20 16:03:16
[forward_only] =>
[languages] => Array
(
[0] => English
)
[title] => My New Survey
[internal_title] => My New Survey
[title_ml] => Array
(
[English] => My New Survey
)
[theme] => 11147
[blockby] =>
[statistics] =>
[links] => Array
(
[edit] => {edit link}
[publish] => {campaign link}
)
The remainder of the survey create object return is an array of survey pages. See the SurveyPage object for more.Update/Copy Survey Return Example (.debug format):
Array
(
[result_ok] => 1
[data] => Array
(
[id] => 1120161
[team] => 406256
[_type] => Survey
[_subtype] => Survey
[status] => In Design
[created_on] => 2012-12-20 15:50:41
[modified_on] => 2012-12-20 17:47:15
[forward_only] =>
[languages] => Array
(
[0] => English
)
[title] => Updated Survey
[internal_title] => Updated Survey
[title_ml] => Array
(
[English] => Updated Survey
)
[theme] => 11147
[blockby] => COOKIE
[statistics] =>
[links] => Array
(
[edit] => {edit link}
[publish] => {publish link}
[campaign] => {campaign link}
)
The remainder of the survey update object return is an array of survey pages. See the SurveyPage object for more.
Delete Survey Return Example (.debug format):
Array
(
[result_ok] => 1
)