ExportCreationRequest
The format of the export file. This can be one of: csv, tsv, json, ndjson, spss, or xml
Possible values: [csv, json, ndjson, spss, tsv, xml]
csvcsvIf true, split multi-value fields into columns.
truetrueCompress the final export file as a ZIP file. Exporting without compression is only recommended for small exports. Large exports may encounter issues when downloading the large files. It is possible in the future that if an export size is too large uncompressed, this flag will be ignored and it will be compressed anyway.
truetrueOnly export responses created before the specified date unless sortByLastModifiedDate is true. In which case only export responses created or modified before the date. See Dates and Times for more information on the date and time format. The end date is exclusive. Note that the creation timestamp is immutable, and is not displayed in the export. For example, updating responses with the resetRecordedDate=true flag will not update the creation timestamp.
2100-01-01T01:00:00Z2040-02-01T01:50:00ZOnly export responses not yet complete. Note that sortByLastModifiedDate doesn't have any impact when this is set to true.
falsefalseIf you provide a filterId, the export will only return responses matching the corresponding filter. For more information on filters and how to create them, see Filtering Responses at Qualtrics Support, or read the response import/export API overview section on using filters.
9b67fbb7-ef89-430d-8ddf-f17f44de9254If true, use a comma as a decimal separator instead of a period.
falsefalseIf true, include display order information in your export. This is useful for surveys with randomization. Note that if used alongside the embeddedDataIds, questionIds, or surveyMetadataIds parameters, this will only apply to the display order information for questions. Flow and block display order information will always be included. Display order fields will have the _DO suffix.
falsefalseMaximum number of responses to export.
Possible values: >= 0
50Recode seen-but-unanswered choices for multi-select questions with this value. If not set, this will be the seenUnansweredRecode value.
99If set, replace newline characters in survey responses with this value. Note: this parameter is only relevant for CSV and TSV.
Recode seen-but-unanswered questions with this value.
0Only export responses created after the specified date unless sortByLastModifiedDate is true. In which case only export responses created or modified after the date. See Dates and Times for more information on the date and time format. The start date is inclusive. Note that the creation timestamp is immutable, and is not displayed in the export. For example, updating responses with the resetRecordedDate=true flag will not update the creation timestamp.
1970-01-01T01:00:00Z2018-01-01T01:50:00ZTimezone used to determine response date values. Data is recorded in UTC, and translates that value to your local time. This can be useful for local survey deadlines. See Dates and Times for more information on time zone format. If this parameter is not provided, dates will be exported in UTC/GMT.
UTCAmerica/ChicagoInstead of exporting the recode (numeric) value for the answer choice, export the text of the answer choice. For more information on recode values, see Recode Values on the Qualtrics Support Page.
falsefalseIf provided, only export embedded data fields from the provided list of Embedded Data IDs. For more information see Embedded Data
If provided, only export answers from the provided list of Question IDs
If provided, only export metadata fields from the provided list of Metadata IDs. This will remove metadata included in export by default. The list of those fields is below:
- startDate
- Start Date
- endDate
- End Date
- status
- Survey Response type (info found here)
- ipAddress
- IP Address
- progress
- Progress (percentage)
- duration
- Duration (in seconds)
- finished
- boolean for whether or not the survey is complete
- recordedDate
- Recorded Date
- _recordId
- Response ID
- locationLatitude
- Latitude
- locationLongitude
- Longitude
- recipientLastName
- Recipient Last Name .
- recipientFirstName
- Recipient First Name .
- recipientEmail
- Recipient Email .
- externalDataReference
- External Data Reference .
- distributionChannel
- Distribution Channel
Provide the continuation token returned from a previous export in order to get new responses recorded (or updated, if sortByLastModifiedDate is set to true) since that export. Note that a token is only returned if either allowContinuation or continuationToken is set. Continuation tokens expire after a week. If you provide a continuation token, it implies allowContinuation and you must not include the allowContinuation field.
UQhcCBAIGwgGCFkIEBscGhIcHxkZHxwGCEQIEBwYGxoaGhoaGgYITwgQGxwaExgcGhkYE1cSet this to true to request a continuation token when this export has finished. Note, when this is set to true, you cannot include a filter.
falsefalseFor columns that have answer labels, export two columns: one that uses recode values and one that uses labels. The label column has an IsLabelsColumn field in the 3rd header row. Note that this cannot be used with useLabels. Use this setting if you wish to export both column labels and numeric values in the same export.
falsefalseSort responses by modified date, which represents the date when a response was last updated or the creation time if the response hasn't changed since it was recorded. Note, when this is set to true, startDate and/or endDate, if provided, will be used to filter responses based on the modified date instead of the creation time alone. This parameter cannot be used together with the filterId parameter. Also, the modified date will be automatically included under an additional LastModifiedDate column in the export. sortByLastModifiedDate can be used in conjunction with continuationToken to periodically get all the new and modified responses since the last export and is the recommended way of handling that use case.
falsefalseIf set to true, the export will include two additional fields named Wave Name and Weight Segment, but only if the survey has a waved weighting scheme defined. For more information see Wave Based Weighting
falsefalse{
"format": "csv",
"breakoutSets": true,
"compress": true,
"endDate": "2040-02-01T01:50:00Z",
"exportResponsesInProgress": false,
"filterId": "9b67fbb7-ef89-430d-8ddf-f17f44de9254",
"formatDecimalAsComma": false,
"includeDisplayOrder": false,
"limit": 50,
"multiselectSeenUnansweredRecode": "99",
"newlineReplacement": "string",
"seenUnansweredRecode": "0",
"startDate": "2018-01-01T01:50:00Z",
"timeZone": "America/Chicago",
"useLabels": false,
"embeddedDataIds": [
"ContactID"
],
"questionIds": [
"QID2"
],
"surveyMetadataIds": [
"startDate"
],
"continuationToken": "UQhcCBAIGwgGCFkIEBscGhIcHxkZHxwGCEQIEBwYGxoaGhoaGgYITwgQGxwaExgcGhkYE1c",
"allowContinuation": false,
"includeLabelColumns": false,
"sortByLastModifiedDate": false,
"includeWaveWeights": false
}