GET /responses to read those.
Because a Results file holds samples of written answers,
exports:create comes with responses:read. Like the Export menu, starting an export requires the permission to view surveys.
Start an export
The call returns
202 with the export and its address in Location. A survey the credential can’t read returns 404 with APK-006-005, and a dashboard it can’t read returns 404 with PUB-015-001.
Who the file is read as
Just as the Export menu’s file holds what its person reads, an export file holds what the credential reads:- An app or an AI assistant reads as the person who connected it.
- An API key reads as the organization, so it exports the dashboards shared with the organization and never a person’s private board. The file names the key as its author, such as “Nightly export (API key)”.
Exports and the plan
Each file counts as one of the plan’s exports this month, in the same count as the Export menu’s files, and once they are used up,POST /exports returns 403 with PLN-001-014. An export that ends without a file doesn’t count. If you send the request again with the same Idempotency-Key, it returns the same export and counts once. When Usertick can’t start an export right now, the request returns 503 with EXP-001-006, and you can try again in a moment.
Follow an export and download the file
statusisqueued,running,succeededorfailed. PollGET /exports/{exportId}until it issucceededorfailed.filedescribes the file while Usertick keeps it, withexpiresAtgiving the time it is deleted. It isnullbefore the file is made, when the export failed and after the file was deleted.errorsays why an export failed:PUB-013-005when the survey or the dashboard is gone or the credential can no longer read it,PUB-004-002when the file couldn’t be made.
GET /exports/{exportId}/download redirects with 302 to a link that downloads the file for five minutes, or with redirect=false returns { "url", "expiresInSeconds" } instead. While the export has no file, the call returns 409 with PUB-013-003. Once the file is deleted, 24 hours after the export finished, it returns 410 with PUB-013-004, and you need to start a new export to get the file again.