Survey Returned Fields v5

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

FieldDescriptionFormat
idSurvey IDstring
team[id]Team IDstring
team[name]Team Namestring
typeProject type (Survey, Poll, Form, Quiz)string
statusProject status (Launched, Closed)string
created_onDate/time createdYYYY-MM-DD HH:MM:SS
modified_onDate/time last modifiedYYYY-MM-DD HH:MM:SS
forward_onlyDisables Back Buttonboolean
languagesArray of translated languagesstring
titleProject/Survey Titlestring
internal_titleInternal Titlestring
title_mlArray of titles for each translation (ex: [English] => Survey Title, [Spanish] =>Encuesta Título)string
themeTheme IDURL
blockbyDuplicate protection type (IP, COOKIE, null)array
statisticsArray of response counts for reach status e.g. partial, complete, etc.string
linksArray of all share linksstring
pagesArray of survey pages. See SurveyPage Returned Fields for more info.array

Example Returns (.debug format)

GetList Return Example (.debug format):

Array
(
    [result_ok] => 1
    [total_count] => 527
    [page] => 1
    [total_pages] => 11
    [results_per_page] => 50
    [data] => Array
        (
            [0] => Array
                (
                    [id] => 1234567
                    [team] => 1234
                    [type] => Survey
                    [status] => Launched
                    [created_on] => 2016-06-02 12:18:55
                    [modified_on] => 2016-06-02 12:19:57
                    [title] => Test Survey
                    [statistics] => 
                    [links] => Array
                        (
                            [edit] => https://app.sgizmo.com/login/v1
                            [publish] => https://app..sgizmo.com/login/v1
                        )

                )

            [1] => Array
                (
                    [id] => 7654321
                    [team] => 4321
                    [type] => Survey
                    [status] => Launched
                    [created_on] => 2016-05-27 14:30:19
                    [modified_on] => 2016-05-27 14:30:53
                    [title] => Second Test Survey
                    [statistics] => Array
                        (
                            [Complete] => 92
                        )

                    [links] => Array
                        (
                            [edit] => 
                            [publish] => www.testsurvey.com/test
                        )

                )

GetSurvey Return Example (.debug format):

Array
(
    [result_ok] => 1
    [data] => Array
        (
            [id] => 1234567
            [team] => Array
                (
                    [0] => Array
                        (
                            [id] => 1234
                            [name] => Test Team
                        )

                )

            [type] => Survey
            [status] => Launched
            [created_on] => 2016-01-22 13:18:08
            [modified_on] => 2016-06-02 12:59:15
            [forward_only] => 
            [languages] => Array
                (
                    [0] => English
                )

            [title] => Test Survey
            [internal_title] => Test Survey - Internal
            [title_ml] => Array
                (
                    [English] => Test Survey
                )

            [theme] => 12345
            [blockby] => NONE
            [statistics] => Array
                (
                    [Partial] => 7
                    [Disqualified] => 53
                    [Deleted] => 2
                    [Complete] => 3010
                    [TestData] => 2269
                )

            [links] => Array
                (
                    [default] => http://app.sgizmo.com/s3/1078944/Test-Survey
                    [campaign] => http://app.sgizmo.com/s3/1078944/Test-Survey
                )

        )

)

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] => 1103632
            [team] => Array
                (
                    [0] => Array
                        (
                            [id] => 1234
                            [name] => Test Team
                        )

                )

            [type] => Quiz
            [status] => Closed
            [created_on] => 2016-06-02 16:48:24
            [modified_on] => 2016-06-02 16:48:24
            [forward_only] => 
            [languages] => Array
                (
                    [0] => English
                )

            [title] => Quiz Test
            [internal_title] => Quiz Test
            [title_ml] => Array
                (
                    [English] => Quiz Test
                )

            [theme] => 68551
            [blockby] => IP
            [statistics] => 
            [links] => Array
                (
                    [default] => https://app.sgizmo.com/s3/1103632/Quiz-Test
                    [campaign] => https://app.sgizmo.com/s3/1103632/Quiz-Test
                )

        )

)

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] => 1103632
            [team] => Array
                (
                    [0] => Array
                        (
                            [id] => 1234
                            [name] => Test Team
                        )

                )

            [type] => Quiz
            [status] => Launched
            [created_on] => 2016-06-02 16:48:24
            [modified_on] => 2016-06-02 16:51:24
            [forward_only] => 
            [languages] => Array
                (
                    [0] => English
                )

            [title] => Quiz Test
            [internal_title] => Quiz Test
            [title_ml] => Array
                (
                    [English] => Quiz Test
                )

            [theme] => 68551
            [blockby] => IP
            [statistics] => 
            [links] => Array
                (
                    [default] => https://app.sgizmo.com/s3/1103632/Quiz-Test
                    [campaign] => https://app.sgizmo.com/s3/1103632/Quiz-Test
                )

        )

)
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
)