SurveyPage Returned Fields v5

 Help Us Improve Our API Documentation!

We're beginning an initiative to improve our API docs. We would love your help!

Please take this quick 4-question survey to help us out! Thank you in advance for your time!

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

Returned Fields for the SurveyPage Object

Field Description Format
id ID of survey page number
title Page title string
properties Page properties (see below) string
description Page description string
questions Array of questions. See SurveyQuestion Returned Fields for more info.
Properties Fields Description Format
hidden Indicates if page is hidden boolean
piped_from ID of question page is piped from string

Example Returns (.debug format)

GetList Return Example (.debug format):

Array
(
    [result_ok] => 1
    [total_count] => 11
    [page] => 1
    [total_pages] => 1
    [results_per_page] => 11
    [data] => Array
        (
            [0] => Array
                (
                    [id] => 1
                    [title] => Array
                        (
                            [English] => Page One
                        )

                    [properties] => Array
                        (
                            [hidden] => 
                        )

                    [description] => Array
                        (
                        )

                    [questions] => Array
                        (
The remainder of the surveypage object get list return is an array of survey questions. See the SurveyQuestion object for more.

GetSurveyPage Return Example (.debug format):

Array
(
    [result_ok] => 1
    [data] => Array
        (
            [id] => 1
            [title] => Array
                (
                    [English] => Page One
                )

            [properties] => Array
                (
                    [hidden] => 
                )

            [description] => Array
                (
                )

            [questions] => Array
                (
The remainder of the surveypage get object return is an array of survey questions. See the SurveyQuestion object for more.

Create SurveyPage Return Example (.debug format):

Array
(
    [result_ok] => 1
    [data] => Array
        (
            [id] => 13
            [title] => Array
                (
                    [English] => TestPage
                )

            [properties] => Array
                (
                    [hidden] => 
                )

            [description] => Array
                (
                )

            [questions] => Array
                (
                )

        )

)

Update SurveyPage Return Example (.debug format):

Array
(
    [result_ok] => 1
    [data] => Array
        (
            [id] => 13
            [title] => Array
                (
                    [English] => TestPage
                )

            [properties] => Array
                (
                    [hidden] => 1
                )

            [description] => Array
                (
                )

            [questions] => Array
                (
                )

        )

)

Delete SurveyPage Return Example (.debug format):

Array
(
    [result_ok] => 1
)