Export Customer Job Result¶
https://{cluster-id}.api.esales.apptus.cloud/api/admin/v4/event-data/export-customer-job-result
GET¶
Download the content, which is a .zip file that contains customer information. More GDPR information is available here.
Request¶
Header parameters¶
| Name | Description | Example |
|---|---|---|
| Api-Key Required | Api-key that was supplied during on-boarding | pkA123456789AB1BE.. |
Query parameters¶
| Name | Description | Example |
|---|---|---|
| jid Required | The id of a event data job. | 962d41f3-1a53-4bb8-bd01-3b85310fb45f |
curl -i \
-X GET \
-H 'Api-Key: pkA123456789AB1BE..' \
"https://{cluster-id}.api.esales.apptus.cloud/api/admin/v4/event-data/export-customer-job-result?jid=962d41f3-1a53-4bb8-bd01-3b85310fb45f"
Response¶
Response codes¶
| Status | Description |
|---|---|
| 403 | Incorrect cluster credentials. |
| 400 | Invalid or missing required arguments. |
| 200 | Request accepted, download customer data which is a zip file. |
Response body¶
Example
application/zip
962d41f3-1a53-4bb8-bd01-3b85310fb45f.zip /
|- file_with.jsonl
|- another_file_with.jsonl
|- ...
or
962d41f3-1a53-4bb8-bd01-3b85310fb45f.zip /
|- empty.txt