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[id] | Team ID | string |
| team[name] | Team Name | string |
| type | Project type (Survey, Poll, Form, Quiz) | string |
| status | Project status (Launched, 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 |
| theme | Theme ID | URL |
| blockby | Duplicate protection type (IP, COOKIE, null) | array |
| statistics | Array of response counts for reach status e.g. partial, complete, etc. | string |
| links | Array of all app links and the default share link | 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 (.json format):
{"result_ok": true,"total_count": "1461","page": 1,"total_pages": 30,"results_per_page": 50,"data": [{"id": "1234567","team": "433737","type": "Standard Survey","status": "Launched","created_on": "2017-04-24 10:44:23","modified_on": "2017-04-24 10:58:20","title": "Survey","statistics": {"Partial": 4,"Complete": 2},"links": {"edit": "[Link to Build Tab]",
"publish": "[Link to Share Tab]",
"default": "[Default Share Link]"}},{"id": "1234568","team": "433737","type": "Standard Survey","status": "Launched","created_on": "2017-04-24 09:53:01","modified_on": "2017-04-24 09:53:55","title": "Survey","statistics": {"Partial": 1},"links": {"edit": "[Link to Build Tab]","publish": "[Link to Share Tab]","default": "[Default Share Link]"}},GetSurvey Return Example (.json format):
{"result_ok": true,"data": {"id": "1234567","team": [{"id": "433737","name": "Team 2"}],"type": "Standard Survey","status": "Launched","created_on": "2016-04-29 13:20:20","modified_on": "2017-04-21 11:11:15","forward_only": false,"languages": ["English"
],"title": "Survey Title","internal_title": "Survey Title","title_ml": {"English": "Survey Title"},"theme": "110045","blockby": "NONE","statistics": {"Partial": 102,"Disqualified": 1,"Complete": 201},"overall_quota": null,"auto_close": null,"links": {"default": "[Default Share 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 (.json format):
{"result_ok": true,"data": {"id": "1234567","team": [{"id": "406257","name": "Team 1"}],"type": "","status": "Launched","created_on": "2017-04-24 18:12:54","modified_on": "2017-04-24 18:12:54","forward_only": false,"languages": ["English"],"title": "Survey","internal_title": "Survey","title_ml": {"English": "Survey"},"theme": "110045","blockby": null,"statistics": null,"overall_quota": null,"auto_close": null,"links": {"default": "[Default Share Link]"
},"pages": [{"id": 1,"title": {"English": "(untitled)"},"properties": {"hidden": false},"description": [],"questions": []},{"id": 2,"title": {"English": "Thank You!"},"properties": {"hidden": false},"description": [],"questions": [{"id": 1,"base_type": "Decorative","type": "INSTRUCTIONS","title": {"English": "Thank you for taking our survey. Your response is very important to us."},"shortname": null,"varname": [],"description": [],"has_showhide_deps": null,"comment": null,"properties": {"hidden": false,"map_key": "instructions"},"options": []}]}]}}
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 (.json format):
{"result_ok": true,"data": {"id": "1234567","team": [{"id": "406257","name": "Team 1"}],"type": "","status": "Launched","created_on": "2017-04-24 18:12:54","modified_on": "2017-04-24 18:12:54","forward_only": false,"languages": ["English"],"title": "Survey","internal_title": "Survey","title_ml": {"English": "Survey"},"theme": "110045","blockby": null,"statistics": null,"overall_quota": null,"auto_close": null,"links": {"default": "[Default Share Link]"
},"pages": [{"id": 1,"title": {"English": "(untitled)"},"properties": {"hidden": false},"description": [],"questions": []},{"id": 2,"title": {"English": "Thank You!"},"properties": {"hidden": false},"description": [],"questions": [{"id": 1,"base_type": "Decorative","type": "INSTRUCTIONS","title": {"English": "Thank you for taking our survey. Your response is very important to us."},"shortname": null,"varname": [],"description": [],"has_showhide_deps": null,"comment": null,"properties": {"hidden": false,"map_key": "instructions"},"options": []}]}]}}
The remainder of the survey update object return is an array of survey pages.
See the SurveyPage object for more.
Delete Survey Return Example (.json format):
{"result_ok": true}