Skip to main content
POST
Start an export

Authorizations

Authorization
string
header
required

An API key (utk_live_...) or an app's OAuth access token (uto_...).

Headers

Idempotency-Key
string

Any 1 to 255 printable ASCII characters, without a space at either end. The answer to the first request with a key is kept for 24 hours per credential: the same request again gets it back (Idempotent-Replayed: true), another request with the key is 409 PUB-002-002, and while the first still runs 409 PUB-002-003. A server error is not kept, and a request that never answered frees its key after 2 minutes: a retry with the key then runs again.

Maximum string length: 255

Body

application/json
kind
enum<string>
required

results (a survey's Results) or dashboard.

Available options:
results,
dashboard
format
enum<string>
required

csv or xlsx; another format is 400 EXP-001-001.

Available options:
csv,
xlsx
surveyId
string<uuid> | null

kind results: the survey.

dashboardId
string<uuid> | null

kind dashboard: the board.

from
string<date-time> | null

The window's start (inclusive); 30 days before to when left out.

to
string<date-time> | null

The window's end (exclusive); now when left out.

timeZone
string | null

An IANA time zone the figures are cut in; UTC by default.

Maximum string length: 64
filters
object | null

The Results filter bar without the date range. A dashboard takes country, device, language and page.

Response

The export.

id
string<uuid>
required
kind
enum<string>
required
Available options:
results,
dashboard
status
enum<string>
required
Available options:
queued,
running,
succeeded,
failed
subject
object
required
format
enum<string>
required
Available options:
csv,
xlsx
file
object | null
required

The file while it is kept; null before it is made, when the export failed, and after it was deleted.

error
string | null
required

Why it failed: PUB-013-005 when the survey or the dashboard is gone or the credential can no longer read it, PUB-004-002 when it couldn't be made. A failed export isn't counted.

url
string<uri>
required
createdAt
string<date-time>
required
Example:

"2026-09-30T10:00:00.000Z"

startedAt
string<date-time> | null
required
Example:

"2026-09-30T10:00:00.000Z"

finishedAt
string<date-time> | null
required
Example:

"2026-09-30T10:00:00.000Z"

Last modified on November 9, 2026