Skip to content

Export Customer Data

GDPR compliance feature

The export customer data job is part of Apptus solutions for enabling GDPR compliance concerning data managed by Apptus eSales Enterprise.

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

Name Type Description Example
customerKey string Visitor id, e.g. UUID / GUID. d9528...e9feca

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"
}
×
Copyright

This online publication is intellectual property of Apptus Technologies. Its contents can be duplicated in part or whole, provided that a copyright label is visibly located on each copy and the copy is used in conjunction with the product described within this document.

All information found in these documents has been compiled with utmost attention to detail. However, this does not guarantee complete accuracy. Neither Apptus Technologies nor the authors shall be held liable for possible errors or the consequences thereof.

Software and hardware descriptions cited in these documents might be registered trademarks. All trade names are subject to copyright restrictions and may be registered trademarks. Apptus Technologies essentially adheres to the manufacturer’s spelling. Names of products and trademarks appearing in this document, with or without specific notation, are likewise subject to trademark and trade protection laws and may thus fall under copyright restrictions.

CLOSE