SurveyQuestion Sub-Object v5

The following API calls are currently available for the SurveyQuestion object:

GET LIST - Get a list of all of your survey questions.

https://api.alchemer.com/v5/survey/123456/surveyquestion

Note: Get requests will cache for 60 seconds. If you make repeated API get requests that are identical, the return will be cached and will thus return identical results.
ParametersExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345True

GET SURVEYQUESTION - Get information about a specified survey question.

https://api.alchemer.com/v5/survey/123456/surveyquestion/1

Note: Get requests will cache for 60 seconds. If you make repeated API get requests that are identical, the return will be cached and will thus return identical results.
ParametersExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345True

CREATE SURVEYQUESTION - Create a new survey question.

https://api.alchemer.com/v5/survey/123456/surveypage/1/surveyquestion?_method=PUT

ParametersExampleRequired
Authentication Credentialsapi_token=abc123&api_token_secret=abc123True
surveypageID of page to add question toTrue
id† *This parameter must be used when adding sub-questions (ex. rows) to the following questions types: table-radio, table-checkbox, table-textbox, table-menu-matrix, table-stars, and group.Question ID of the parent questionFalse
typeradio, checkbox, menu, text, essay, email, multitext, single-image, multi-image, contsum, rank-dragdrop, table-radio, table-checkbox, table-textbox, table-menu-matrix, table-stars, file, instructions, media, audio, video, hidden, urlredirect, group, heatmap, texthighlighter, httpinsert, javascriptFalse
titleQuestion textFalse
descriptionDescription textFalse
afterQuestion ID to followFalse
varnameSPSS Variable Name*False
shortnameShortname/AliasFalse
Look & Feel PropertiesExampleRequired
properties[disabled]trueFalse
properties[exclude_number]trueFalse
properties[hide_after_response]trueFalse
properties[option_sort]ALPHA,NONE,SHUFFLE,true,falseFalse
properties[orientation]HORZ,VERTFalse
properties[labels_right]trueFalse
properties
[question_description_above]
trueFalse
properties[custom_css]CSS template hookFalse
properties[placeholder][English]**question placeholder text (open text questions)False
Validation PropertiesExampleRequired
properties[required]trueFalse
properties[soft-required]trueFalse
properties[force_numeric]trueFalse
properties[force_percent]trueFalse
properties[force_currency]trueFalse
properties[subtype]email, dateFalse
properties[min_number]valueFalse
properties[max_number]valueFalse
properties[min_answers_per_row]valueFalse
properties[minimum_response]valueFalse
properties[inputmask][mask]RegEx PatternFalse
properties[inputmask][message]RegEx PatternFalse
properties[defaulttext]Default text or reporting valueFalse
Logic PropertiesExampleRequired
properties[hidden]trueFalse
properties[piped_from]Question ID to pipe fromFalse
Continuous Sum PropertiesExampleRequired
properties[max_total]valueFalse
properties[max_total_noshow]trueFalse
properties[must_be_max]trueFalse
File Upload PropertiesExampleRequired
properties[maxfiles]1-10False
properties[extentions]png,gif,jpg,doc,xls,docx,xlsx,pdf,txtFalse
URL Redirect PropertiesExampleRequired
properties[url]Redirect URLFalse
properties[outbound][n][fieldname]Variable NameFalse
properties[outbound][n][mapping]Question ID for variable you wish to mapFalse
properties[outbound][n][default]Default Value to be passed when blankFalse
Heatmap PropertiesExampleRequired
properties[heatmap_image]https://url-of-your-image.jpgFalse
Text Highlighter PropertiesExampleRequired
properties[messages][th_content][English]This%20is%20the%20text%20to%20highlighterFalse
Http Insert PropertiesExampleRequired
properties[data_type]response,fields (fields must be configured via the UI)True
properties[url]http%3A%2F%2Fwww.demo.testom%2Fwebhook.phpTrue
properties[data_json]true (only works when properties[data_type] is set to "response"False
Audio & Video Element PropertiesExampleRequired
properties[aurl]url of audio/video content formatted as //www.example.comTrue
properties[http]http,https (defaults to http if invalid value is passed)True
Dropdown Menu Grid PropertiesExampleRequired
properties[limits][]array of dropdown menu answer options, ex.
properties[limits][]=apple&properties[limits][]=orange
True
Action Properties ExampleRequired

properties[javascript_code]

Base64-encoded JavaScript code. ex: YWxlcnQoIkhlbGxvISBJIGFtIGFuIGFsZXJ0IGJveCEhIik7

False


Properties[Option_sort] parameter sorting behavior definitions :

  1. ALPHA: alphabetical sort on values created.
  2. NONE: Original order when the question was created.
  3. SHUFFLE: Randomized order of question value created.
  4. true: alphabetized sort of values created.
  5. false: leave original order of values created.

This parameter must be used when adding sub-questions (ex. rows) to the following questions types: table-radio, table-checkbox, table-textbox, table-menu-matrix, table-stars, and group.

‡Use to create rows of a Dropdown Menu Grid

*For question types with multiple fields this must be specified as an array with the option ID as the key. For example, the follow call is used to specify the SPSS variable names for each row of a Textbox List question.
 https://api.alchemer.com/v4/survey/2120303/surveypage/12/surveyquestion/23.debug?_method=POST&varname[10001]=Comedy&varname[10002]=Drama&varname[10003]=Foreign&varname[10004]=Western

**Required parameter - language version of the placeholder text must be specified.

Back to the Top

UPDATE SURVEYQUESTION - Update a specified surveyquestion.

https://api.alchemer.com/v5/survey/123456/surveyquestion/1?_method=POST

ParametersExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345True
titleQuestion textFalse
descriptionDescription textFalse
varnameSPSS Variable Name*False
shortnameShortname/AliasFalse
Look & Feel PropertiesExampleRequired
properties[disabled]trueFalse
properties[exclude_number]trueFalse
properties[hide_after_response]trueFalse
properties[option_sort]ALPHA,NONE,SHUFFLE,true,falseFalse
properties[orientation]HORZ,VERTFalse
properties[labels_right]trueFalse
properties[question_description_above]trueFalse
properties[custom_css]CSS template hookFalse
properties[placeholder][English]**question placeholder text (open text questions)False
Validation PropertiesExampleRequired
properties[required]trueFalse
properties[soft-required]trueFalse
properties[force_numeric]trueFalse
properties[force_percent]trueFalse
properties[force_currency]trueFalse
properties[min_number]valueFalse
properties[max_number]valueFalse
properties[min_answers_per_row]valueFalse
properties[minimum_response]valueFalse
properties[inputmask]RegEx PatternFalse
properties[defaulttext]Default text or reporting valueFalse
Logic PropertiesExampleRequired
properties[hidden]trueFalse
properties[piped_from]Question ID to pipe fromFalse
Continuous Sum PropertiesExampleRequired
properties[max_total]valueFalse
properties[max_total_noshow]trueFalse
properties[must_be_max]trueFalse
File Upload PropertiesExampleRequired
properties[maxfiles]1-10False
properties[extentions]png,gif,jpg,doc,xls,docx,xlsx,pdf,txtFalse
URL Redirect PropertiesExampleRequired
properties[url]Redirect URLFalse
properties[outbound][n][fieldname]Variable NameFalse
properties[outbound][n][mapping]Question ID for variable you wish to map or url if mapping from a URL variableFalse
properties[outbound][n][url]The name of the URL variable mapped from, if mapping from a URL variable
properties[outbound][n][default]Default Value to be passed when blankFalse
Heatmap PropertiesExampleRequired
properties[heatmap_image]https://url-of-your-imageTrue
Text Highlighter PropertiesExampleRequired
properties[messages][th_content][English]This%20is%20the%20text%20to%20highlighterFalse
Http Insert PropertiesExampleRequired
properties[data_type]response,fields (fields must be configured via the UI)True
properties[url]http%3A%2F%2Fwww.demo.testom%2Fwebhook.phpTrue
Audio & Video Element PropertiesExampleRequired
properties[aurl]url of audio/video content formatted as //www.example.comTrue
properties[http]http,https (defaults to http if invalid value is passed)True
Dropdown Menu Grid PropertiesExampleRequired
properties[limits][]array of dropdown menu answer options, ex.
properties[limits][]=apple&properties[limits][]=orange
True
Action Properties ExampleRequired

properties[javascript_code]

Base64-encoded JavaScript code. ex: YWxlcnQoIkhlbGxvISBJIGFtIGFuIGFsZXJ0IGJveCEhIik7

False


*For question types with multiple fields this must be specified as an array with the option ID as the key. For example, the follow call is used to specify the SPSS variable names for each row of a Textbox List question.
 https://api.alchemer.com/v4/survey/2120303/surveypage/12/surveyquestion/23.debug?_method=POST&varname[10001]=Comedy&varname[10002]=Drama&varname[10003]=Foreign&varname[10004]=Western

**Required parameter - language version of the placeholder text must be specified.

DELETE SURVEYQUESTION - Delete a specified survey question.

https://api.alchemer.com/v5/survey/123456/surveyquestion/1?_method=DELETE

Deleting grid rows is not supported.
ParametersExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345True


Creating a Grid Question with the API

  1. Create the parent question with one of the grid question types (table-radio, table-checkbox, table-textbox, table-menu-matrix). After doing this, note the question ID of this question, this is the parent question. 
  2. Create the columns of the grid by adding a 'surveyoption' for each column using the CREATE SURVEYOPTION. 
  3. Create the rows by creating questions of the appropriate type and include 'id' parameter. The id is the question id of the parent question created in step 1.