API 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 long term, Legacy Custom Scripting Actions will be switched to read-only. The exact date on this is to be determined; we will send notifications well ahead of time.

These functions allow you to make some common API calls to the SurveyResponse object.

sgapiList - This function returns the list of responses for the given survey. This is equivalent to a get list on the SurveyResponse object via the RestAPI.

sgapiListAdd - This function posts a response to the given survey using the array of items. This is equivalent to creating a SurveyResponse object via the RestAPI.

sgapiListRemove - This function removes the given response from the given survey. This is equivalent to deleting a SurveyResponse object via the RestAPI.

sgaiListReplace - This function replaces the given response for the given survey with the array items. This is equivalent to updating a SurveyResponse object via the RestAPI.