Automations File Service API
Introduction
The Automations File Service API exposes a secured and isolated file store for you to manage files intended for a Qualtrics Automation. You may upload a file, particular to an Automation, to an HTTPS endpoint. When the Automation is scheduled to run, it will process any new files targeted to that Automation.
Files uploaded to the Automations File Service will remain for 60 days. Automations supports several data import sources, including SFTP. When an Automation consumes a file from one of these data import sources, it will store the file in the Automations File Service file store when processing the file and for preserving a historical record. When choosing a data import source, we recommend the Automations File Service for uploading files.
This API is not yet generally available. It is available as part of Early Access to receive feedback. Be aware that there may be significant changes to this API with short notice until the time that the API is made Generally Available.
The maximum file size for this API is 500 megabytes.
The timeout limit for this API is 10 minutes.
The API calls in this documentation are written with the base URL datacenterId.qualtrics.com. You should change the base URL to reflect the correct datacenter for your brand. If you do not know the datacenter ID, you can look in the URL you use to access Qualtrics, or in your account settings to find this. API calls may still work if you call the wrong datacenter, as your request will be proxied to the correct datacenter. However, the API call may fail entirely.
Authentication
- API Key: api_token
- OAuth 2.0: public_oauth2
This is a schema for x-api-token header authentication.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-API-TOKEN |
This is a schema for a public oauth2 api.
Security Scheme Type: | oauth2 |
|---|---|
OAuth Flow (clientCredentials): | Token URL: https://ca1.qualtrics.com/oauth2/token Scopes:
|
OAuth Flow (authorizationCode): | Token URL: https://ca1.qualtrics.com/oauth2/token Authorization URL: https://ca1.qualtrics.com/oauth2/auth Scopes:
|
Contact
Qualtrics Support: support@qualtrics.com
License
Apache 2.0