Skip to main content

Data Request Status API

The Data Request Status API returns the status and data from a previously submitted Delete or Export request.

The responses vary based on which request you sent and your integration type. You will need the request_id from the Delete or Export API response to include in your request.


Note: APIs can be used 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/gdpr/{partner_ID}/{request_id}

HTTP method

GET

Path parameter

Path parameter

Data type

Required

Description

partner_id

string

yes

Your Besitos partner ID.

request_id

string

yes

The request_id returned in the Delete or Export request.


Examples

Request

GET https://wall.besitos.ai/data/partner/gdpr/CwI606dZ/f19cf1c4-cea2-4ca9-ab25-de2e45ab98b4

Response for Delete request

{
"success": true,
"request": {
"id": "7b3f07fd-6343-4b88-bffb-051bc5652b73",
"action": "delete",
"status": "completed",
"partner_id": "CwI606dZ",
"partner_user_ids": [
"sampleuser1",
"sampleuser2"
],
"format": "json",
"requested_at": "2026-02-25T10:22:42-05:00",
"processed_at": "2026-02-25T10:23:31-05:00",
"completed_at": "2026-02-25T10:23:31-05:00",
"expires_at": null,
"error_message": null,
"progress": {
"total": 2,
"completed": 1,
"failed": 1,
"pending": 0,
"percentage": 100
}
},
"data": {
"data": {
"verification": {
"deletion_completed": true,
"total_processed": 1,
"verification_note": "Data deletion completed and verified"
},
"summary": {
"message": "Successfully processed 1 subscriber deletion requests from 2 partner user IDs. Note: 1 partner user IDs were not found.",
"success": true,
"subscriber_ids": [
"b-clkxsnseqacvefhfn8"
],
"processed_count": 1,
"found_partner_user_ids": [
"sampleuser1"
],
"provided_partner_user_ids": [
"sampleuser1",
"sampleuser2"
],
"not_found_partner_user_ids": [
"sampleuser2"
]
}
}
}
}

Response for Export request

{
"success": true,
"request": {
"id": "3f4f183b-c32e-4982-97b5-2c79ffe07402",
"action": "export",
"status": "completed",
"partner_id": "CwI606dZ",
"partner_user_ids": [
"sampleuser1",
"sampleuser2"
],
"format": "json",
"requested_at": "2026-02-25T10:22:42-05:00",
"processed_at": "2026-02-25T10:23:31-05:00",
"completed_at": "2026-02-25T10:23:31-05:00",
"expires_at": "2026-03-04T10:23:31-05:00",
"error_message": null,
"progress": {
"total": 2,
"completed": 1,
"failed": 1,
"pending": 0,
"percentage": 100
}
},
"data": {
"data": [
{
"status": true,
"sub_id": null,
"balance": "0.00",
"last_name": null,
"country_id": 1,
"first_name": null,
"partner_id": "CwI606dZ",
"email_address": "[email protected]",
"payout_records": [],
"enrolled_offers": [],
"partner_user_id": "sampleuser1",
"redeem_requests": [],
"activity_summary": {
"last_activity_timestamp": "2026-02-25T10:22:21-05:00"
},
"offer_participation": [],
"device_platforms_used": [],
"last_updated_timestamp": "2026-02-25T11:22:26-05:00",
"account_creation_timestamp": "2026-02-25T10:22:21-05:00",
"support_interactions_count": 0
},
null
]
}
}

Response attributes

All dates and timestamps are returned in EST.

Delete User Data

Attributes

Data Type

Description

Example

success

boolean

Indicates whether the request was successfully received and processed.

true

Request

id

string

Unique identifier for the deletion request.

"7b3f07fd-6343-4b88-bffb-051bc5652b73"

action

string

Request type: delete or export

"export"

status

string

Current status of the request: pending, processing, completed, failed.

"completed"

partner_id

string

Your unique partner ID.

"CwI606dZ"

partner_user_ids

array

User IDs included in the request.

"partner_user_ids": [ "sampleuser1", "sampleuser2" ]

format

string

Format used for the request output (for example, json or csv).

"json"

requested_at

datetime

Date and time the deletion request was submitted.

"2026-02-25T15:22:42-05:00"

processed_at

datetime

Date and time the request processing began.

"2026-02-25T10:23:31-05:00"

completed_at

datetime

Date and time the request was completed.

"2026-02-25T10:23:31-05:00"

expires_at

datetime

Date and time the request record expires.

"2026-03-04T10:23:31-05:00"

error_message

string

Error details, if any occurred during processing. Returns null when no error exists.

null

Progress

total

number

Total number of user IDs included in the request.

2

completed

number

Number of user IDs successfully processed.

1

failed

number

Number of user IDs that failed processing.

1

pending

number

Number of user IDs still awaiting processing.

0

percentage

number

Percentage of the request that has been processed.

100

Data

Verification

deletion_completed

boolean

Indicates whether all requested deletions have been completed.

true

total_processed

number

Total number of user records processed.

1

verification_note

string

Verification summary for the request.

"Data deletion completed and verified"

Summary

message

string

Summary of the request outcome. May include additional details about any failures.

"Successfully processed 1 subscriber deletion requests from 2 partner user IDs. Note: 1 partner user IDs were not found."

success

boolean

Indicates whether the deletion request completed successfully.

true

subscriber_ids

array

Besitos subscriber IDs associated with successfully processed users.

"b-clkxsnseqacvefhfn8"

processed_count

number

Number of users successfully processed.

1

found_partner_user_ids

array

Partner user IDs found in the database.

"sampleuser1"

provided_partner_user_ids

array

Partner user IDs included in the original request.

"sampleuser1", "sampleuser2"

not_found_partner_user_ids

array

Partner user IDs that were not found in the database.

"sampleuser2"

Export User Data

Some of the attributes defined below may not be included in your dataset because they are not supported by your integration type.

Attributes

Data Type

Description

Example

success

boolean

Indicates whether the request was successfully received and processed.

true

Request

id

string

Unique identifier for the Export request.

"3f4f183b-c32e-4982-97b5-2c79ffe07402"

action

string

Request type

"export"

status

string

Current status of the request.

"completed"

partner_id

string

Your unique partner ID.

"CwI606dZ"

partner_user_ids

string

User IDs included in the request.

"partner_user_ids": [ "sampleuser1", "sampleuser2" ]

format

array

Export format requested for the operation.

"json"

requested_at

datetime

Date and time the export request was submitted.

"2026-02-25T15:22:42.000000Z"

processed_at

datetime

Date and time the request processing began.

"2026-02-25T15:23:31.000000Z"

completed_at

datetime

Date and time the request was completed.

"2026-02-25T15:23:31.000000Z"

expires_at

datetime

Date and time the exported data expires and is no longer available.

"2026-03-04T15:23:31.000000Z"

error_message

string

Error details, if any occurred during processing. Returns null when no error exists.

null

Progress

total

number

Total number of user IDs included in the request.

2

completed

number

Number of user records successfully exported.

1

failed

number

Number of user records that failed to export.

1

pending

number

Number of user records still awaiting processing.

0

percentage

number

Percentage of the request that has been processed.

100

Data

status

boolean

User account status. true indicates an active account; false indicates an inactive account.

true

sub_id

string

Sub ID associated with the user.

"558b904"

balance

number

Current account balance available to the user.

"5.50"

last_name

string

User's last name.

"User"

country_code

string

User's ISO 3166-1 alpha-2 country code.

US

first_name

string

User's first name.

"Test"

partner_id

string

Your Besitos partner ID.

"CwI606dZ"

email_address

string

User's email address.

payout_records

array

User payout history, including payout amounts, statuses, and processing timestamps.

"[{\"amount\":10,\"status\":5,\"processed_at\":\"2024-11-08T16:44:48.000000Z\"},{\"amount\":10,\"status\":5,\"processed_at\":\"2024-11-08T16:57:43.000000Z\"},{\"amount\":10,\"status\":3,\"processed_at\":\"2024-12-10T10:07:46.000000Z\"}]"

enrolled_offers

array

Offers in which the user is currently enrolled, including offer IDs, names, and enrollment timestamps.

"[{\"offer_id\":\"UnjTSQWE5z6x\",\"offer_name\":\"3 Tiles: Tile Matching Games - Android\",\"enrolled_at\":\"2026-02-06 02:33:29\"}]"

partner_user_id

string

User's unique ID in your system.

"T7D8uz2Bo5kbdhqWfkjvbfv"

redeem_requests

array

User redemption or withdrawal requests, including amounts and request timestamps.

"[{\"amount\":\"10.00\",\"requested_at\":\"2024-11-08T16:57:30.000000Z\"},{\"amount\":\"10.00\",\"requested_at\":\"2024-12-10T14:14:25.000000Z\"},{\"amount\":\"10.00\",\"requested_at\":\"2024-12-10T14:28:41.000000Z\"}]"

Activity Summary

last_activity_timestamp

datetime

Date and time of the user's most recent offer-related activity.

"2026-02-25T10:22:21-05:00"

offer_participation

array

Offers in which the user has participated, including offer IDs, names, and participation timestamps.

[{\"offer_id\":\"UnjTSQWE5z6x\",\"offer_name\":\"3 Tiles: Tile Matching Games - Android\",\"participated_at\":\"2025-09-30 12:52:10\"}]

device_platforms_used

string

Device platform used by the user. Possible values are android and ios.

android

last_updated_timestamp

datetime

Date and time the user's record was last updated.

"2026-02-25T11:22:26-05:00"

account_creation_timestamp

datetime

Date and time the user account was created. Returned only when supported by your integration type.

"2026-02-25T10:22:21-05:00"

support_interactions_count

number

Total number of support interactions associated with the user.

2

Did this answer your question?