Parameters
Parameter | Accepted Format | Accepted Options | Required | Description |
---|---|---|---|---|
Campaign ID | string | Y | Unique identifier for the campaign Navigate to your form's Settings Page to find the Campaign ID | |
statusGroup | string | active pending completed denied archived cancelled | N | See below. If not specified, then assume 'active' |
completedAtStart | date & time (ISO 8601 UTC Format) | N | responses that were completed after this time example format 2024-01-15T15:00:00 | |
completedAtEnd | date & time (ISO 8601 UTC Format) | N | responses that were completed before this time example format 2024-01-15T15:00:00 | |
firstSubmittedAtStart | date & time (ISO 8601 UTC Format) | N | responses where step 1 was submitted after this time example format 2024-01-15T15:00:00 | |
firstSubmittedAtEnd | date & time (ISO 8601 UTC Format) | N | responses where step 1 was submitted before this time example format 2024-01-15T15:00:00 | |
lastSubmittedAtStart | date & time (ISO 8601 UTC Format) | N | responses where most recent step was submitted after this time example format 2024-01-15T15:00:00 | |
lastSubmittedAtEnd | date & time (ISO 8601 UTC Format) | N | responses where most recent was submitted before this time example format 2024-01-15T15:00:00 | |
waitingOnStep | integer | N | responses currently waiting at this step | |
page | integer | N | pagination |
Status Groups
Status Groups represent the groupings of responses in a particular stage of the process.
Status Group | Definition |
---|---|
Active (All) | All forms that are either Pending or Completed |
Pending | All currently Pending forms at any step of the Workflow (including statuses such as viewed, unopened, send back, etc.) |
Completed | All forms with a status “Completed” or “Marked Completed” |
Denied | All forms that have been denied using the Deny option in the approval process |
Archived | All forms that have been archived from the Responses page |
Cancelled | All forms that have been cancelled |
Field Numbers
You can see Field Numbers on the form by selecting Field Numbers as the Badge Type when in the Document Editor: