An export finished

POST

Once when an export reaches completed. download_url is null: fetch urls.self with your key for a fresh link.

Request Body^required

Media typeapplication/json

WebhookEvent_ExportSummary_

object

api_version

Api Version

The payload version

string

default: v1

Allowed value: v1

created

required

Created

When the event happened

string format: date-time

data

required

WebhookData_ExportSummary_

The event’s object

object

object

required

ExportSummary

The topic’s object

object

bytes

required

Any of:

integer

integer

null

null

completed_at

required

Any of:

string

string format: date-time

null

null

dataset

required

Dataset

What the file holds

string

Allowed values: profiles responses quiz_analytics audit_events

download_url

Any of:

string

string

null

null

download_url_expires_at

Any of:

string

string format: date-time

null

null

error

required

Any of:

string

string

null

null

expires_at

required

Expires At

When the export and its file are deleted

string format: date-time

filters

required

ExportFilters

The filters the export was requested with

object

from

Any of:

string

string format: date

null

null

quiz_id

Any of:

string

string

/^quiz_[0-9a-f]{32}$/

null

null

search

Any of:

ProfileSearch

ProfileSearch

Who to find: the list filters of GET /v1/profiles except q, plus person facts and an answer filter, an OR of AND groups. Send the same body with every page: a cursor belongs to the search that answered it and is refused with any other body.

object

from

Any of:

string

string format: date

null

null

groups

Any of:

Array<object>

Array<object>

<= 4 items

ProfileSearchGroup

object

all

required

All

Every slot must hold: a term, or {any: [terms]}; at most 8 terms in the group, counting the terms inside any

Array

>= 1 items <= 8 items

Any of:

ProfileSearchTerm

ProfileSearchTerm

object

component_key

Any of:

string

string

<= 200 characters

null

null

dimension_id

Any of:

string

string

<= 200 characters

null

null

kind

required

Kind

Choice | number | date | text | email | phone: a question of the quiz (page_key + component_key); points: a dimension (dimension_id); formula: a formula component (page_key + component_key); winner: the top dimension (dimension ids in option_ids); session: how the shopper’s session ended (value completed | abandoned, page_key the page they left on)

string

Allowed values: choice number date text email phone points formula winner session

max

Any of:

number

number

string

string

null

null

min

Any of:

number

number

string

string

null

null

op

required

Op

Choice: in | not_in; number, points, formula: eq | lt | gt | between; date: eq | before | after | between; text: contains | equals | matches | answered | not_answered; email, phone: answered | not_answered; winner: in; session: equals. not_in means answered the question and picked none of these; not_answered means took the quiz and left the question unanswered.

string

Allowed values: in not_in eq lt gt between before after contains equals matches answered not_answered

option_ids

Any of:

Array<string>

Array<string>

<= 50 items

null

null

option_labels

Any of:

Array<string>

Array<string>

<= 50 items

null

null

page_key

Any of:

string

string

<= 200 characters

null

null

quiz_id

required

Quiz Id

The quiz the term reads

string

/^quiz_[0-9a-f]{32}$/

value

Any of:

number

number

string

string

null

null

ProfileSearchAny

ProfileSearchAny

object

any

required

Any

At least one of these terms must hold; plain terms only

Array<object>

>= 2 items <= 8 items

ProfileSearchTerm

object

component_key

Any of:

string

string

<= 200 characters

null

null

dimension_id

Any of:

string

string

<= 200 characters

null

null

kind

required

Kind

Choice | number | date | text | email | phone: a question of the quiz (page_key + component_key); points: a dimension (dimension_id); formula: a formula component (page_key + component_key); winner: the top dimension (dimension ids in option_ids); session: how the shopper’s session ended (value completed | abandoned, page_key the page they left on)

string

Allowed values: choice number date text email phone points formula winner session

max

Any of:

number

number

string

string

null

null

min

Any of:

number

number

string

string

null

null

op

required

Op

Choice: in | not_in; number, points, formula: eq | lt | gt | between; date: eq | before | after | between; text: contains | equals | matches | answered | not_answered; email, phone: answered | not_answered; winner: in; session: equals. not_in means answered the question and picked none of these; not_answered means took the quiz and left the question unanswered.

string

Allowed values: in not_in eq lt gt between before after contains equals matches answered not_answered

option_ids

Any of:

Array<string>

Array<string>

<= 50 items

null

null

option_labels

Any of:

Array<string>

Array<string>

<= 50 items

null

null

page_key

Any of:

string

string

<= 200 characters

null

null

quiz_id

required

Quiz Id

The quiz the term reads

string

/^quiz_[0-9a-f]{32}$/

value

Any of:

number

number

string

string

null

null

null

null

has_email

Any of:

boolean

boolean

null

null

has_marketing_consent

Any of:

boolean

boolean

null

null

has_order

Any of:

boolean

boolean

null

null

has_phone

Any of:

boolean

boolean

null

null

is_returning

Any of:

boolean

boolean

null

null

match

Match

Any_session: any time they took the quiz counts; latest_completed_per_quiz: only their latest completed take of each quiz

string

default: any_session

Allowed values: any_session latest_completed_per_quiz

quiz_id

Any of:

string

string

/^quiz_[0-9a-f]{32}$/

null

null

to

Any of:

string

string format: date

null

null

null

null

to

Any of:

string

string format: date

null

null

tz

Any of:

string

string

<= 64 characters

null

null

format

required

Format

The file’s format

string

Allowed values: csv json

id

required

Id

The export

string

/^exp_[0-9a-f]{32}$/

requested_at

required

Requested At

When the export was requested

string format: date-time

row_count

required

Any of:

integer

integer

null

null

source

required

Source

Where the export was requested

string

Allowed values: api dashboard

started_at

required

Any of:

string

string format: date-time

null

null

status

required

Status

Pending | running | completed | failed | expired

string

Allowed values: pending running completed failed expired

urls

required

Urls

Self: this export on the API; fetch it for a fresh download link

object

key

additional properties

string

id

required

Id

The event id, also sent as the webhook-id header; deduplicate on it

string

/^evt_[0-9a-f]{32}$/

type

required

Type

The topic: quiz.started | quiz.finished | quiz.abandoned | identity.captured | quiz.published | experiment.started | experiment.ended | profile.created | profile.updated | export.completed | webhook.endpoint.disabled | ping

string

Responses

200

Any 2xx within 10 seconds acknowledges the event

4XX

410 ends the delivery and disables the endpoint; any other 4xx but 408 and 429 ends it

5XX

Retried, as are 408, 429, a timeout and a network error: seven retries over about 28 hours, then the delivery is dead