Export a profile's data
- Path
/profiles/exports- Auth
- Secret key · server only
const url = 'https://releva.ai/api/v0/profiles/exports';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"email":"maria@example.com","sendToEmail":"privacy@demo-store.example.com"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://releva.ai/api/v0/profiles/exports \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "email": "maria@example.com", "sendToEmail": "privacy@demo-store.example.com" }'Starts an asynchronous export of everything Releva holds about one person: profile rows, devices, events and
attribution records, including those of profiles merged into it. When it is ready, a download link
(valid for 7 days) is e-mailed to sendToEmail. Pass exactly one of email, profileId or phoneNumber.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Exactly one of email, profileId or phoneNumber is required (checked after validation).
object
Receives the download link.
+ followed by the international dialling code and number, digits only (2-32 characters).
Example
{ "email": "maria@example.com", "sendToEmail": "privacy@demo-store.example.com"}Responses
Section titled “Responses”Accepted for asynchronous processing.
object
Example
{}Authentication or validation error.
object
Human-readable error. Several validation errors are joined with a space.
Examples
{ "message": "The 'sendToEmail' field is required."}{ "message": "Exactly one of (profileId", "phoneNumber": null, "email) is required.": null}{ "message": "The object '' contains forbidden keys: 'format'."}{ "message": "phoneNumber must be a valid telephone number starting with + and international code, e.g. +1. Got 0888000111 instead."}{ "message": "Authorization header is missing."}The domain is disabled.
object
Human-readable error. Several validation errors are joined with a space.
Example
{ "message": "Domain is disabled. Please reach out to support@releva.ai to enable it."}Request body larger than 800 KB.
object
Human-readable error. Several validation errors are joined with a space.
Example
{ "message": "request entity too large"}Unexpected server error.
object
Human-readable error. Several validation errors are joined with a space.
Example
{ "message": "An internal error occurred."}