Lua Scripting Resources

Important Update to Custom Scripting

SurveyGizmo's CustomScript Action now supports the LUA programming language.


Legacy Custom Scripting Language Deprecation Plans 

  1. New accounts (created after October 29, 2018) will only have the option to use Lua in scripts.
  2. As of October 29, 2018 Custom Scripting Actions will default to Lua as the scripting type in the Custom Scripting Action for accounts created before this date. You will be able to switch to the Legacy Custom Scripting; though we highly encourage using Lua.
  3. In the long term, Legacy Custom Scripting Actions will be switched to read-only. Read-only scripts will continue to function; you will just be prevented from editing. The exact date on this is to be determined; we will send notifications well ahead of time.


 Go to our Legacy Scripting Documentation.

While SurveyGizmo is one of the most flexible survey tools around, we get requests for customizations that are not available out of the box. This is where JavaScript and Custom Scripting can save the day. If you have scripting chops you can use the JavaScript action or the Custom Scripting action to achieve the survey of your dreams.


[article("bodfy")]

This function returns an array of all the questions (of a particular type) on a particular page.

Parameters*DescriptionRequired
typethe question typetrue
pageidthe ID of the pagetrue

*Provide parameters in the above order.

Type Possible ValuesCorresponding Survey Question
CASCADING_DROPDOWNCascading Dropdown Menu
CHECKBOXCheckboxes
CONJOINT_NEWChoice-based Conjoint
CONT_SUMContinuous Sum
ESSAYEssay/Long Answer
FILEFile Upload
GROUPContact Form and Custom Group
HEATMAPImage Heatmap
IMAGE_SELECTImage Select (Single and Multi)
MATRIXCustom Table
MAXDIFFMax Diff
MENUDropdown Menu
MULTI_SLIDERSlider List
MULTI_TEXTBOXTextbox List
NPS®Net Promoter Score®
RADIORadio Buttons, Likert (Rating)
RANKDrag & Drop and Ranking Grid
REACTIONAudio and Video Sentiment
SIGNATURESignature
SLIDERSlider
TABLEGrid question types (Semantic Diff, Star Rating Grid, Radio Button Grid, Dropdown Menu List, Checkbox Grid, All Card Sorts, Dropdown Menu Grid ). Tables are evaluated by row/subquestion such that each row that is answered increments the return by 1.
TEXTBOXText fields including (textbox, number, percent, email, and date)
TEXTHIGHLIGHTERText Highlighter

Net Promoter®, NPS®, NPS Prism®, and the NPS-related emoticons are registered trademarks of Bain & Company, Inc., Satmetrix Systems, Inc., and Fred Reichheld. Net Promoter Score℠ and Net Promoter System℠ are service marks of Bain & Company, Inc., Satmetrix Systems, Inc., and Fred Reichheld.