Get Workflow Submissions

Unique workflow ID

Transform to apply to form for output. Transform must be configured and designated for for output. Available transforms may be listed via the /transforms endpoint

Maximum number of results to return (default 50, maximum 50)

Number of results to skip before selecting results. Offset is zero based.

Field to sort by (currently supported - "created", "modified")

Order of sort, if sortBy is specified. One of [1 (ascending),-1 (descending)]

Whether to include deleted objects in response

Filter condition against submission "metadata" field. Value must be a stringified MongoDB query condition (see Examples, below). MongoDB dot notation is supported for keys.

NOTE: MongoDB selectors that can be nested inside queries (such as Comparison and Element Selectors, e.g. $eq, $in, $exists) are supported. The following Logical Selectors are also supported: $and, $or, $nor

Examples:

• metadataFilter: {"checkpoints.complete": 1234}

• metadataFilter: {"checkpoints.complete": {"$exists": true}, "checkpoints.processed": {"$exists": false}}

  • Will return submissions where both metadata.checkpoints.complete exists AND metadata.checkpoints.processed does not exist

Whether to include the untransformed raw submission data in addition to the transformed data. Raw submission data may contain Cloud Storage Delivery URLs.

Whether to include base64 PDF data in addition to the PDF url (for "njk-pdf" transforms)

When transformName is specified, Cloud Storage URLs are already resolved to the original base64 value. When this flag is specified, resolve Cloud Storage URLs to base64 data inside "rawData", as well.

Comma-separated list of dot-notation data fields to retrieve; for example, &dataFields=field1,also.field2 will retrieve {"data":{"field1":"v1","also":{"field2":"v2"}}}. Do not include "data" in front of each field. All other submission fields will always be retrieved.

Filter conditions against submissions. Currently supported filter conditions are userId, created, and modified. The filters should be ; separated, as shown below. NOTE: When filtering on created and modified, all timestamps are in UTC.

Examples:

• filter=userId=john@doe.com will fetch all submissions owned by "john@doe.com"
• filter=userId=john@doe.com;created>2019-06-11T21:50:57.067Z will fetch all submissions owned by "john@doe.com" and created after "2019-06-11T21:50:57.067Z" (UTC)
• filter=modified=2019-06-11T21:50:57.067Z will fetch submissions modified at exactly "2019-06-11T21:50:57.067Z" (UTC)
• filter=created>2019-06-11T00:00:00.000Z;created<2019-06-20T00:00:00.000Z will fetch submissions created between "2019-06-11T00:00:00.000Z" (UTC) and "2019-06-20T00:00:00.000Z" (UTC)

Supported operators (as specified in this library api-query-params):

• key=val type=public
• key>val count>5
• key>=val rating>=9.5
• key<val createdAt<2016-01-01
• key<=val score<=-5
• key!=val status!=success
• key=val1,val2 country=GB,US
• key!=val1,val2 lang!=fr,en
• key phone
• !key !email
• key=/value/<opts> email=/@gmail\.com$/i
• key!=/value/<opts> phone!=/^06/

Note: multiple forward slashes (/) are interpreted as a regex. To use a string comparison wrap your parameter with string(). Ex. email=string(/@gmail.com$/i).