SurveyGizmo Functions

Important Update to Custom Scripting

SurveyGizmo's CustomScript Action now supports the LUA programming language. Visit our NEW Lua Scripting Resources!

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 future, any Legacy Custom Scripting Actions will be switched to read-only.

These functions were built to allow you to interact with your surveys to build the exact functionality you want.

Question Functions

These are functions that allow you to evaluate and affect survey questions. For example, sgapiGetValue, sgapiSetValue, sgapiIsAnswered, sgapiHideQuestion, etc.

Option Functions

These are functions that allow you to evaluate and affect question options. For example, sgapiHideOption, sgapiGetPipeValues, sgapiSetPipeValues, etc.

Page Functions

These are functions that allow you to evaluate and affect survey pages. For example, sgapiHidePage, sgapiJumpToPage, sgapiCurrentPageSku, etc.

Survey Response Functions

These are functions that allow you to evaluate and affect the survey response. For example, sgapiGetSurveyProgress, sgapiDisqualify, sgapiSubmitSurvey, etc.

Aggregate Functions

These are functions that allow you to aggregate across responses. For example, sgapiGetQuestionResponseCount, sgapiResultsQuestionTotal, sgapiResultsQuestionAverage, etc.