Export customer data¶

The export customer data job must be performed before any customer data can be downloaded. It is recommended to perform an export and download before any customer data is removed. Export and removal can run concurrently but it is recommended to start the export first.

A customerKey argument is supplied to start an export job of all available data related to the given key. Linked keys and their related data will also be included in the export job.

The export customer data job works with archived data only. The export job will start once the data from the job initiation date has been archived. Default time for archiving is 5 days. Exported data will be available for download for approximately a week from the time the customer data job status returns done.

When executing queries with the GDPR API, an Api-Key header is required for authentication.

Method¶

POST

URL format¶

/api/v2/event-data/create-export-customer-job?customerKey={customerKey}

Parameters¶

Request body¶

Not applicable

Request content-type¶

Not applicable

Response content-type¶

application/json

Responses¶

A response will always return a Customer data job status.

Examples¶

Request¶

cURL¶

#!/bin/bash
curl -i \
-X POST \
-H "Api-Key: {PRIVATE-KEY}" \
 "https://{cluster-id}.api.esales.apptus.cloud/api/v2/event-data/create-export-customer-job?customerKey=d9528030-509c-4e0f-b585-7168f1e9feca"

Response¶

{
  "jid": "ca24b4e2-34ab-406a-a4db-b30b0247837a",
  "status": "created"
}