Skip to main content

Export User Data API

Requesting to export user data.

The Export User Data API allows partners to request users' records, including their offer participation and activity. This helps partners with traffic outside the US comply with data protection regulations such as GDPR.

After you send the request, use the Data Request Status API to get the response.


​Note: You can use APIs with our iFrame, but not with our Wallet solution.


Endpoint

Before you attempt to connect, complete the steps in Prepare to Connect to Besitos APIs.

Endpoint URL

https://wall.besitos.ai/data/partner/export/{partner_ID}/users

HTTP method

POST

Path Parameter

Path parameter

Data type

Required

Description

partner_id

string

yes

Your Besitos partner ID.


Examples

Request

{
"user_ids": ["sampleuser1", "sampleuser2"]
}

Response

{
"success": true,
"message": "Export request queued for processing",
"request_id": "f19cf1c4-cea2-4ca9-ab25-de2e45ab98b4",
"status": "pending",
"format": "json",
"data": null
}

You can use the request_id value from the response to confirm the status of the request via the Data Request Status API.

Did this answer your question?