Export Profile Data & Events (Async)

The Profile Data Export lets you request a copy of all the data Releva holds about a user, given their email, phone number or profileId. The export is prepared asynchronously and a download link is emailed to the address you specify.

Do I need to call it? #

GDPR gives users the right to access the personal data held about them. This API allows you to fulfil such data subject access requests in an automated way.

Request Parameters #

You may perform requests to the API using the following curl equivalent:

curl -XPOST -H 'Authorization: Bearer <secretKey>' -H 'Content-Type: application/json' 'https://releva.ai/api/v0/profiles/exports' -d '{"email": "<email>", "sendToEmail": "your_email@gmail.com"}'
curl -XPOST -H 'Authorization: Bearer <secretKey>' -H 'Content-Type: application/json' 'https://releva.ai/api/v0/profiles/exports' -d '{"profileId": "<profileId>", "sendToEmail": "your_email@gmail.com"}'
curl -XPOST -H 'Authorization: Bearer <secretKey>' -H 'Content-Type: application/json' 'https://releva.ai/api/v0/profiles/exports' -d '{"phoneNumber": "<phoneNumber>", "sendToEmail": "your_email@gmail.com"}'

Request Body #

Note that email, profileId and phoneNumber are optional but we need exactly one of them. Any field not listed above is rejected with HTTP status 400.

A successful response will return HTTP Status 202 with an empty response body ({}). The export is then prepared in the background, and an email with a download link is sent to sendToEmail once it is ready. The link is valid for 7 days.

What the export contains #

The export is a JSON Lines file (one JSON object per line) containing the user’s profile, their devices, every event recorded for them, and their attribution records. If the user’s profile was merged with another profile, the export also includes the data recorded under the merged profile.

Response Format #

An error response will return a HTTP 4xx or 5xx status code and have the following structure:

{
  "message": "A description of the error and how to fix it, if it's a client error."
}