Toggle menu

helper.getSubmissionHistory()

Returns the submission history of the pages of a form.

Executed

Server-side or client-side

Arguments

None.

Returns

Array of objects. Each object has the following properties.

PropertyDescription
pageNameThe name of the page
pageInstanceEither 0 (first page visit) or 1 (all subsequent visits)
submissionActionThe name of the action that caused the page to be submitted. One of "NEXT", "PREV", "BACK", "FINISH"
submissionActionFieldNameThe field name of the button that was pressed to trigger the action
submissionActionLabelThe label of the button that was pressed to trigger the action

Example

This is the response from a two page form. The user has completed pages one and two, then navigated back to page one, then forwards again to page two.

[{
    "pageName": "PAGE1",
    "pageInstance": 0,
    "submissionAction": "NEXT",
    "submissionActionLabel": "The Next Label",
    "submissionActionFieldName": "PAGE1WIZARDBUTTONS"
}, {
    "pageName": "PAGE2",
    "pageInstance": 0,
    "submissionAction": "BACK",
    "submissionActionLabel": "Back",
    "submissionActionFieldName": "FIELD2"
}, {
    "pageName": "PAGE1",
    "pageInstance": 1,
    "submissionAction": "NEXT",
    "submissionActionLabel": "The Next Label",
    "submissionActionFieldName": "PAGE1WIZARDBUTTONS"
}]

Last modified on September 13, 2023

Share this page

Facebook icon Twitter icon email icon

Print

print icon