The Conversion Data API includes detailed data on all user actions that result in user rewards or partner payouts. Since this dataset can be large, we recommend using query parameters to refine and limit its scope for analysis.
While some data in the Conversion Data API is also sent as a postback, connecting to it ensures that you will continue to receive current and accurate conversion data even if your server experiences an outage or downtime.
Preparing to connect
Follow these steps to prepare to connect to Besitos APIs:
Have your partner ID ready.
Contact your Besitos Account Manager to request API access.
Generate and save your bearer token for authentication.
Continue reading for a complete description of the API parameters and response attributes, or visit our Postman collection to start testing.
Endpoint
Endpoint URL | https://wall.besitos.ai/data/partner/conversions |
HTTP method | GET |
Refresh rate | 5 minutes |
Query parameters
The request supports the following optional query parameters.
Query parameter | Data type | Required | Description |
| string | no | The start date of the query range should be formatted as YYYY-MM-DD. The default range includes the last 7 days. |
| string | yes | The end of the query range is formatted as YYYY-MM-DD. The default range includes the last 7 days. |
| string | no | ID of the user to retrieve |
| string | no | ID of the offer to retrieve |
| boolean | no | Returns reversed events |
| integer | no | Number of records to display per page |
| integer | no | Page number for paginated results |
| string | no | Offer type: offer (game) or survey |
Examples
Request
Request
GET https://wall.besitos.ai/data/partner/conversions?from_date=2024-12-01&to_date=2024-12-16&user_id=tWAek9twniogX0e&offer_id=NvGopKLbVIA9&is_reverse=false&per_page=2&page=3;
Response
Response
{
"data": [
{
"user_id": "asdfn-234ghhh",
"transaction_id": 2601266,
"reward": 0,
"payout": 11.05,
"offer_id": "tU5z8PU5BIR9",
"offer_name": "Club Vegas Slots",
"note": "Successfully Installed the App",
"date_time": "2024-12-04 06:24:55",
"reward_local_currency": 0,
"goal_id": "tU5z8PU5BIR9_0"
},
{
"user_id": "asdfn-234ghhh",
"transaction_id": 2601267,
"reward": 40,
"payout": 0,
"offer_id": "tU5z8PU5BIR9",
"offer_name": "Club Vegas Slots",
"note": "Level 91 Reached",
"date_time": "2024-12-04 06:25:36",
"reward_local_currency": 4000,
"goal_id": "tU5z8PU5BIR9_133"
},
],
"links": {
"first": "https://wall.besitos.ai/data/partner/conversions?page=1",
"last": "https://wall.besitos.ai/data/partner/conversions?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://wall.besitos.ai/data/partner/conversions?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "https://wall.besitos.ai/data/partner/conversions",
"per_page": 1000,
"to": 6,
"total": 6
}
}Response attributes
Attributes | Data Type | Description | Example |
Data |
|
|
|
| string | The user ID for a user in your database should be up to 50 characters. IDs are case insensitive. |
|
| integer | A unique transaction ID for tracking conversions. If received twice, do not process again unless a reversal occurs, indicated by ‘reverse=1’. |
|
| integer | The user’s reward amount in USD. |
|
| integer | The user's reward in your currency (points or coins) is multiplied by its ratio to USD. |
|
| float | The amount you (the partner) receive in USD.
This amount corresponds to the |
|
| string | Unique offer ID |
|
| string | The name of the offer the user is participating in. |
|
| string | A description of the goal. |
|
| string/datetime | The date and time (EST) when the event occurred. |
|
| string | ID of a goal in the offer |
|
| boolean | If a reversal occurs,
Reversals typically occur when a user is no longer eligible for an offer. For example, they previously installed the game. |
|
| string | If surveys are enabled, the type can be "offer" (game) or "survey." |
|
| string | If surveys are enabled and survey conversions exist, the survey ID is used to identify the survey. |
|
Links |
|
|
|
| string | URL for the first page | |
| string | URL for the last page
If only 1 page, then the value will be 1 | |
| string | URL for the previous page
If only 1 page, then the value is null | |
| string | URL for the next page
If only 1 page, then the value is null | |
Meta |
|
|
|
| integer | Current page number |
|
| integer | Range of items shown on the current page |
|
| integer | Total number of pages available |
|
| array | URLs for pagination navigation
If none are available, the value is empty | includes |
| string | Base URL for pagination | |
| integer | Number of items displayed per page |
|
| integer | Total number of items |
|
*If you're interested in enabling surveys, please contact your Besitos Account Manager at [email protected] or through your project channel in Slack.