Skip to main content

Deals User Data API

Learn about the User Data API use and response attributes.

Updated this week

The Deals User Data API offers real-time details on all available, ongoing, and completed deals for a specific user. It checks the offer budget status and only returns deals with available budget.

The Deals User Data API handles offer sorting and prioritization, making it easy to organize and display the deals users have played or are currently playing, along with the goals they have achieved. We suggest adding a tab or label in your app or website to distinguish between in-progress, completed, and available deals.

Overall, the Deals User Data API enables a simpler, faster implementation than our Deals Data API.


Preparing to connect

Follow these steps to prepare to connect to Besitos APIs:

  1. Have your partner ID ready.

  2. Contact your Besitos Account Manager to request API access.

  3. 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/deals/{partner_id}/{user_id}
https://wall.besitos.ai/data/deals/{partner_ID}/{partner_user_id}/{sub_id} 

HTTP Method

GET

Refresh rate

5 minutes

Path parameters

If you segment users in your database, this endpoint can include the optional sub_ID parameter. Learn more about user segmentation.

Path parameter

Data type

Required

Description

partner_id

string

yes

Your Besitos partner ID.

partner_user_id

string

yes

The ID of a user in your database.

Maximum 65 characters

sub_id

string

no

The ID of the segment to which the user belongs in your database.

Maximum 50 characters


Examples

Request

GET https://wall.besitos.ai/data/CwI606dZ/122334zw/002367?device_platform=android

Response

{
"available": [
{
"id": "zQhlHhoj5FHa",
"image_text": "Dish Network",
"title": "Dish Network",
"image": "https://cdn.kashkick.com/offers/wGDxNKbi8KcM.jpg",
"square_image": null,
"large_image": "https://cdn.kashkick.com/offers/4QE4fDvi4IM2.jpg",
"card_text": "Enjoy your favorite channels with Dish!",
"amount": 30,
"cpa": 84,
"url": "https://wall-aws-staging.besitos.ai/redirect/zQhlHhoj5FHa/b-qM22DxBgo2scqV8rzv",
"description": "<p><span style=\"background-color: rgb(255, 255, 255); color: rgb(45, 62, 80);\">Welcome to the future of television with DISH! Enjoy a remarkable blend of cutting-edge integrated set-top technology, extensive channel lineup, and 1st place customer satisfaction(JD Power 5 yrs in a row). Join us now for an unrivaled TV experience!</span></p><p><strong style=\"background-color: rgb(255, 255, 255); color: rgb(45, 62, 80);\">Purchase a plan to earn your Test Account dev reward.</strong></p>",
"details": "<p>*New Users Only</p><p>All rewards applied to user accounts will have a Pending Period typically ranging from 1 day to 31 days (average of 14 days) to validate transactions. Pending Rewards may not be redeemed until the transaction(s) have been validated and the reward(s) actualized.&nbsp;</p>",
"points": [
{
"title": "$200 Prepaid Card Offer – New customers get a $200 prepaid card when signing up, adding instant value from day one."
},
{
"title": "2-Year TV Price Guarantee – Lock in your rate with no surprises or hidden fees for two full years."
},
{
"title": "All-in-One Entertainment – Enjoy live TV and top streaming apps all in one place with the DISH Hopper system."
},
{
"title": "Fast, Reliable Installation – Get set up quickly with next-day installation available in many areas."
}
],
"goals": [
{
"goal_id": "zQhlHhoj5FHa_0",
"amount": 30,
"cpa": "84.00",
"text": "Purchase a plan",
"days_left": null,
"goal_type": "linear",
"section": "linear",
"position": 1
}
],
"categories": [
{
"name": "Entertainment"
}
],
"state_filter": {
"type": "include",
"states": [
"CA",
"CO"
]
}
},
{
"id": "S7i3ZARxCFti",
"image_text": "Craftsy",
"title": "Craftsy",
"image": "https://cdn.kashkick.com/offers/qNKFQsVhAxTN.jpg",
"square_image": null,
"large_image": "https://cdn.kashkick.com/offers/DEeOJJR64k18.jpg",
"card_text": "Get your Craftsy Premium Membership for only $1.49 for your first full year!",
"amount": 1,
"cpa": 3.6,
"url": "https://wall-aws-staging.besitos.ai/redirect/S7i3ZARxCFti/b-qM22DxBgo2scqV8rzv",
"description": "<p>Craftsy is your source for inspiration where you can explore videos and resources to spark your creativity. Expand your skills with access to over 2000 easy-to-follow classes across more than 20 categories taught by industry-leading experts.</p><p><strong>&nbsp;Sign up for the premium membership to earn your Test Account dev reward.</strong></p>",
"details": "<p>*New Users Only</p><p>All rewards applied to user accounts will have a Pending Period typically ranging from 1 day to 31 days (average of 14 days) to validate transactions. Pending Rewards may not be redeemed until the transaction(s) have been validated and the reward(s) actualized.</p>",
"points": [
{
"title": "Tune in to Live Events with your favorite instructors!"
},
{
"title": "Only for $1.49 (normally $123)!"
},
{
"title": "New classes and content added regularly!"
}
],
"goals": [
{
"goal_id": "S7i3ZARxCFti_0",
"amount": 1,
"cpa": "3.60",
"text": "Purchase a premium membership",
"days_left": null,
"goal_type": "linear",
"section": "linear",
"position": 1
}
],
"categories": [
{
"name": "Food & Drink"
}
],
"state_filter": {
"type": "all",
"states": []
}
},
{
"id": "tcInbmRITlAA",
"image_text": "Ark7",
"title": "Ark7",
"image": "https://cdn.kashkick.com/offers/JMPnVDDw5U1J.jpg",
"square_image": null,
"large_image": "https://cdn.kashkick.com/offers/xoHO47Cqjw17.jpg",
"card_text": "Invest in rental homes - share by share with Ark7!",
"amount": 22.5,
"cpa": 75,
"url": "https://wall-aws-staging.besitos.ai/redirect/tcInbmRITlAA/b-qM22DxBgo2scqV8rzv",
"description": "<p>Ark7 empowers its community to invest in rental homes - share by share. We feature high yield, professionally managed, rental properties nationwide. Investors receive monthly passive income while enjoying appreciation and portfolio diversification.</p><p><strong>Purchase your first share of $100 or more to earn your Test Account dev reward!</strong></p><p><em style=\"font-weight: 700; color: unset;\">Why you'll love Ark7:</em></p><ul><li>Our hybrid approach of Artificial Intelligence plus local expertise are constantly hand-picking best investment opportunities, automate sourcing, leasing and property management.</li><li>Extra savings and tax benefits are passed on to investors.</li><li>No hidden fees, no surprise ever. Ark7 holds a small percentage of funds to cover property sourcing and management expenses.</li></ul>",
"details": "<p>*New Users Only</p><p>All rewards applied to user accounts will have a Pending Period typically ranging from 1 day to 31 days (average of 14 days) to validate transactions. Pending Rewards may not be redeemed until the transaction(s) have been validated and the reward(s) actualized.</p>",
"points": [
{
"title": "Receive monthly distribution straight to your account."
},
{
"title": "Your data and transaction are safeguarded."
},
{
"title": "Complete legal and financial disclosure accessible 24/7 and readily searchable."
}
],
"goals": [
{
"goal_id": "tcInbmRITlAA_0",
"amount": 0,
"cpa": "0.00",
"text": "Complete the registration",
"days_left": null,
"goal_type": "linear",
"section": "linear",
"position": 1
},
{
"goal_id": "tcInbmRITlAA_13066",
"amount": 22.5,
"cpa": "75.00",
"text": "Purchase your first share of $100 or more",
"days_left": null,
"goal_type": "linear",
"section": "linear",
"position": 2
}
],
"categories": [
{
"name": "Investing"
}
],
"state_filter": {
"type": "exclude",
"states": [
"AL",
"GA"
]
}
}
],
"in_progress": [],
"completed": [
{
"id": "1jJqFHOFGoLF",
"image_text": "Aura",
"title": "Aura",
"image": "https://cdn.kashkick.com/offers/q2T4WvjOv1W1.jpg",
"square_image": null,
"large_image": "https://cdn.kashkick.com/offers/E2JFr6467vqe.jpg",
"card_text": "Stay Safe From All Types of Malware with Aura!",
"amount": 3.5,
"cpa": 12,
"url": "",
"description": "<p>Aura Inc provides all the security features you need to protect you, your family, your devices, and your personal and financial information. It’s integrated, complete protection for peace of mind and digital wellbeing.</p><p><strong>Purchase a plan to earn your Test Account dev reward.</strong></p><p><strong><em>Why you'll love Aura:</em></strong></p><ul><li><strong>Anti-Ransomware:</strong> Eliminates attacks that encrypt your files or devices and hold them for ransom</li><li><strong style=\"color: rgb(22, 22, 22);\">Anti-Spyware:</strong><span style=\"color: rgb(22, 22, 22);\"> </span>Spots spyware before it can secretly gather personal info and share it with thieves</li><li><strong>Anti-Adware:</strong> Stops advertisers from installing unwanted tracking software on your devices</li><li><strong>Anti-Trojans:</strong> Detects and blocks malicious files which masquerade as a legitimate application</li></ul>",
"details": "<p>*New Users Only</p><p>All rewards applied to user accounts will have a Pending Period typically ranging from 1 day to 31 days (average of 14 days) to validate transactions. Pending Rewards may not be redeemed until the transaction(s) have been validated and the reward(s) actualized.</p>",
"points": [
{
"title": "Antivirus protection for up to 10 devices."
},
{
"title": "Protect against ransomware, trojans, and more."
},
{
"title": "Military-grade VPN and Password Manager."
}
],
"goals": [
{
"goal_id": 0,
"amount": 3.5,
"cpa": "12.00",
"text": "Purchase a plan",
"daysLeft": null,
"completed": true,
"failed": false,
"install": false,
"linear": 1,
"section": 1,
"completed_datetime": "2025-11-26 08:40:09",
"expires_at": "",
"expire_datetime": "",
"reachedAt": "2025-11-26 08:40:09",
"reachedAtTs": 1764164409000,
"secondsLeft": null,
"deadLine": null,
"daysToComplete": null
}
],
"categories": [
{
"name": "Services"
}
],
"history_amount": 3.5
}
],
"terms_of_service": "https://wall-aws-staging.besitos.ai/terms",
"privacy_policy": "https://wall-aws-staging.besitos.ai/privacy-policy",
"faq": "https://wall-aws-staging.besitos.ai/faq",
"support": "https://wall-aws-staging.besitos.ai/support/CwI606dZ/T7D8uz2Bo5kbdhqWfkjvbfv",
"currency": "$",
"balance": 51
}


Response attributes

Attributes marked with * must be displayed to users, as they highlight essential earning requirements (e.g., operating system restrictions or the timeframe to complete an offer). The daysleft value specifically indicates how many days a user has remaining to complete the goal and get the reward.

Attribute

Data Type

Description

Example

Offer appearance and details

available in_progress

completed

string

The state of the offer in the user's account. States:

  • available = user hasn’t started

  • in progress = user is currently participating and has time remaining to reach goals

  • completed = no time remaining to participate in the offer

"available"

state_filter

string

Include or exclude offers by state.

Type can be all, include, or exclude.

States must be in two-letter abbreviation format.

Only for available games—not for in-progress or completed deals.

"type": "all", "states": []

or

"type": "include", "states": ["FL", "CA"]

or

"type": "exclude", "states": ["AZ", "MO"]

id

string

Unique identifier for the offer.

"r0y9t6zuxixf"

imagetext

string

Short promotional text for the offer.

"Get paid to share which websites you browse with MobileXpression!"

title

string

Deal (offer) title

"MobileXpression Panel"

image

square_image

large_image

string

Offer image layout types and locations (URL)

"image": "https://origin-production.kashkick.com/offers/JQw68nhLw0wl.webp",

"square_image": "https://origin-production.kashkick.com/offers/P5xErSepRhkr.webp",

"large_image": "https://origin-production.kashkick.com/offers/8JCqeDVZoAqZ.webp"

cardtext

string

Additional promotional text.

"Easiest money ever! Just download this app and keep it on your phone for 31 days."

amount

integer

The user’s earnings (points, coins, or dollars) after completing the goal.

If you’ve set your currency, the value will reflect that currency; otherwise, it will be in USD.

5

cpa

float

The amount you (the partner) earn in USD.

15

url

string

Directs the user to the offer with these parameters:

  • sub ID (optional)

  • partner ID

  • info - (optional) to pass additional information, such as click or session ID, via postback

Note: The URL expires after 30 minutes. Keep it updated to avoid broken links.

"http://127.0.0.1:8001/redirect/r0y9t6zuxixf/b-mltwnrpu4otbw3xsth"

description*

text

Description of the offer.

"<p><strong>Easiest money ever! Just download this app and keep it on your phone for 31 days.</strong></p><p><span style=\"background-color: rgb(255, 255, 255);\">MobileXpression is currently looking for mobile phone users to share some of the mobile websites you're browsing on. </span></p><p><strong style=\"background-color: rgb(255, 255, 255);\">After 1 week you'll get to play an instant rewards game as a prize. To get your KashKick reward, perform the following easy steps: 1) Sign up, 2) Download the app, 3) Keep the app installed for at least 31 days, 4) Collect your reward.</strong></p><p><em style=\"background-color: rgb(255, 255, 255);\">Note: Removal of the app within 31 days will lead to a reversal of any pending reward. </em></p>"

details*

string

Guidelines for completing the offer.

"<p>*New Users Only.</p><p>All rewards applied to user accounts will have a Pending Period typically ranging from 1 day to 31 days (average of 14 days) to validate transactions. Pending Rewards may not be redeemed until the transaction(s) have been validated and the reward(s) actualized. Chargebacks will lead to the reversal of any pending rewards.</p>"

Goals

goal_id

string

ID of a goal in the offer.

"r0y9t6zuxixf_0"

amount

float

The amount the user will earn in points, coins, or dollars after completing the goal.

If you’ve configured your currency, the value will be in that currency; otherwise, it will be in US dollars.

5

cpa

float

The amount you (the partner) earn in USD when the user completes this goal.

This amount corresponds to the value returned for payout in the Conversion Data API.

15

text

string

Short description of the goal.

"Keep App Installed 31 Days"

daysleft*

integer

The number of days the user has to complete the goal from the installation date.

This is a static value.

The value is null for the “install” goal.

null

goal_type

string

A "linear" goal must be completed in a specific order.

A "non-linear" goal can be completed at any time during the offer duration.

"linear"

section

string

Determines which section of the timeline the goal will be displayed in.

"Linear" goals must be completed in a specific order.

"linear"

categories

name

string

The name of the category the deal is in.

"Surveys"

position

string

The position (order) of the goal on the offer timeline.

1

completed

boolean

"True" if the user completes the goal on time.

"False" if the user does not complete the goal on time.

Note: Only available for in-progress offers.

"completed": "true"

failed

boolean

"True" if the user does not complete the goal on time

"False" if the user completes the goal on time

Note: Only available for in-progress offers.

"failed": "false"

completed_datetime

string/datetime

The date and time at which the user completed the goal.

If the goal is completed on time, "completed" : "true" and "completed_datetime" : "[datetime]".

If the goal is completed after the allotted time, "completed" : "false" and "completed_datetime" : "[datetime]".

If the user did not complete the goal, "completed": "false" and "completed_datetime": "".

Note: Only available for in-progress offers.

"2025-01-30 02:06:18"

expires_at

date

The date on which the goal will expire. Dates are calculated by EST.

This is a dynamic value calculated from the “install” goal date.

The value is empty for the install goal.

Note: Only available for in-progress offers.

"2025-02-01"

expire_datetime

datetime

The date and time at which the goal will expire. Dates and times are set to EST. This is a dynamic value calculated from the "install" goal date. The value is empty for the install goal.

Note: Only available for in-progress offers.

"2025-02-01 09:28:34"

User earnings

history_amount

float

The amount (in your currency or USD) the user has earned.

100

currency

string

Your currency symbol, if specified; otherwise, the currency symbol will be "$".

$

balance

float

The amount the user can withdraw (in your currency or USD).

10

For help, contact your Besitos Account Manager or our Implementation Team at [email protected] or via your project channel in Slack.

Did this answer your question?