Skip to main content

ExportCreationRequest

formatformat (string)required

The format of the export file. This can be one of: csv, tsv, spss, or excel

Possible values: [csv, tsv, spss, excel]

Default value: csv
Example: csv
compresscompress (boolean)

Compress 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.

Default value: true
Example: true
formatDecimalAsCommaformatDecimalAsComma (boolean)

If true, use a comma as a decimal separator instead of a period.

Default value: false
Example: false
limitlimit (integer)

Maximum number of records to export.

Possible values: >= 0

Example: 50
newlineReplacementnewLineReplacement (string)

If set, replace newline characters in records with this value. Note: this parameter is only relevant for CSV and TSV.

timeZonetimeZone (string)

Timezone used to determine response date values. Data is recorded in UTC, and translates that value to your local time. See Dates and Times for more information on time zone format. If this parameter is not provided, dates will be exported in UTC/GMT.

Default value: UTC
Example: America/Chicago
useLabelsuseLabels (boolean)

Instead 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.

Default value: false
Example: false
startDatestring<date-time>

Only export records created after the specified date unless sortByLastModifiedDate is true. Dates and Times for more information on the date and time format. The start date is inclusive.

Default value: 1970-01-01T01:00:00Z
Example: 2018-01-01T01:50:00Z
endDatestring<date-time>

Only export records created before the specified date unless sortByLastModifiedDate is true. See Dates and Times for more information on the date and time format. The end date is exclusive.

Default value: 2100-01-01T01:00:00Z
Example: 2040-02-01T01:50:00Z
continuationTokencontinuationToken (string)

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.

Example: UQhcCBAIGwgGCFkIEBscGhIcHxkZHxwGCEQIEBwYGxoaGhoaGgYITwgQGxwaExgcGhkYE1c
allowContinuationallowContinuation (boolean)

Set 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.

Default value: false
Example: false
sortByLastModifiedDatesortByLastModifiedDate (boolean)

Sort 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.

Default value: false
Example: false
fieldsfield (string)[]

List of field names to be exported. If provided, only fields from the provided list will be exported

ExportCreationRequest
{
  "format": "csv",
  "compress": true,
  "formatDecimalAsComma": false,
  "limit": 50,
  "newlineReplacement": "string",
  "timeZone": "America/Chicago",
  "useLabels": false,
  "startDate": "2018-01-01T01:50:00Z",
  "endDate": "2040-02-01T01:50:00Z",
  "continuationToken": "UQhcCBAIGwgGCFkIEBscGhIcHxkZHxwGCEQIEBwYGxoaGhoaGgYITwgQGxwaExgcGhkYE1c",
  "allowContinuation": "false",
  "sortByLastModifiedDate": "false",
  "fields": [
    "id"
  ]
}