Download Customer Data¶
GDPR compliance feature
The download customer data job is part of Apptus solutions for enabling GDPR compliance concerning data managed by Apptus eSales 3 Enterprise.
The download customer data job can only be performed on an export job with the job status done
. 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 jid
argument is supplied to return the export job as a binary data stream in zip
format. The contents of the zip
-file is one or more text files of the JSON Lines format, i.e. not regular array-wrapped json
-files, or if no data could be found for the specified customer key, a file named empty.txt
.
Disclaimer
The format of the zip
-file content may change without notice.
Exported data will be available for download for approximately a week from the time the customer data job status returns done
. The export job will be removed once the download is completed.
When executing queries with the GDPR API, an Api-Key
header is required for authentication.
Method¶
GET
URL format¶
/api/v2/event-data/export-customer-job-result?jid={jid}
Parameters¶
Name | Type | Description | Example |
---|---|---|---|
jid | string | Unique id generated for an export or removal job. | ca24b4e...247837a |
Request body¶
Not applicable
Request content-type¶
Not applicable
Response content-type¶
application/zip
Responses¶
A binary stream of a zip
-file.
Examples¶
Request¶
cURL¶
#!/bin/bash
curl -i \
-X GET \
-H "Api-Key: {PRIVATE-KEY}"
"https://{cluster-id}.api.esales.apptus.cloud/api/v2/event-data/export-customer-job-result?jid=ca24b4e2-34ab-406a-a4db-b30b0247837a"
Response¶
A binary stream of a zip
-archive containing data for the supplied customer. The zip
-archive may contain several files and the following is an extract from a file called recent_atc.jsonl
.
{"time":"2020-06-15T02:50:25Z","timeOfLastInteraction":"2020-06-15T02:50:24Z","variants":["1234567-1-42"]}
{"time":"2020-06-15T02:50:26Z","timeOfLastInteraction":"2020-06-15T02:50:25Z","variants":["1234567-2-43"]}