« Back to Documentation Overview

get_survey

Section: Surveys
Version: 1.5.0


Get single survey using SURVEY_ID.


Parameters
stringAPI_KEY
object
stringsurveySURVEY_ID
Return Value
objectSURVEY_ID
stringnameMy survey 1
stringtitleTell me something about yourself.
stringdescriptionTrying to engage my potential customers
objectquestions
objectQUESTION_ID
stringnameWhat car do you own?
stringnoteYou may select multiple brands
objectoptions
objectOPTION_ID
stringnameother
stringstatusclosed
stringcreated_on2012-01-01 00:00:00

Example Request JSON

[
    "API_KEY",
    {
        "survey": "SURVEY_ID"
    }
]

Example Response JSON

{
    "SURVEY_ID": {
        "name": "My survey 1",
        "title": "Tell me something about yourself.",
        "description": "Trying to engage my potential customers",
        "questions": {
            "QUESTION_ID": {
                "name": "What car do you own?",
                "note": "You may select multiple brands",
                "options": {
                    "OPTION_ID": {
                        "name": "other"
                    }
                }
            }
        },
        "status": "closed",
        "created_on": "2012-01-01 00:00:00"
    }
}
API-wide Errors
API key verification failed API key verification failed
API client IP not allowed API client IP not allowed
Invalid params Attribute params must be reference to hash