The Deals API provides all deals available to your users, regardless of budget or status. It is intended for partners who want to develop their own methods for ordering and displaying deals.
This API provides more flexibility but demands more management effort. For example, you must regularly check the budget status of each offer to display only those with available funds. Additionally, it does not include progress details for individual users.
Alternatively, our Deals User Data API delivers deals targeted to specific users, taking into account the offer budget status. Consequently, the Deals User Data API is often preferred by partners for its quicker and easier implementation.
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/deals/{partner_id} |
HTTP Method | GET |
Refresh rate | 5 minutes |
Path parameters
Path parameter | Data type | Required | Description |
| string | yes | Your Besitos partner ID. |
Query parameters
The request supports the following optional query parameters.
Query parameter | Data type | Required | Description |
| string | no | The ID of the deal you want to retrieve. If this is not provided, all offers are returned. |
| integer | no | The number of records to display per page. |
| integer | no | The number of the page you want to view. |
Examples
Request
Request
GET https://wall.besitos.ai/data/partner/deals/CwI606dZ/zQhlHhoj5FHa
Response
Response
{
"data": [
{
"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,
"amount_currency": "$",
"url": "https://wall-aws-staging.besitos.ai/api-redirect/CwI606dZ/zQhlHhoj5FHa/615441a1-38ce-4022-adcb-552cf542afb3?partner_user_id=",
"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. </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
}
],
"budget_status": "Active",
"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,
"amount_currency": "$",
"url": "https://wall-aws-staging.besitos.ai/api-redirect/CwI606dZ/S7i3ZARxCFti/615441a1-38ce-4022-adcb-552cf542afb3?partner_user_id=",
"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> 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
}
],
"budget_status": "Active",
"categories": [
{
"name": "Food & Drink"
}
],
"state_filter": {
"type": "all",
"states": []
}
},
{
"id": "GU1TASHFZgtI",
"image_text": null,
"title": "Albert IOS",
"image": "https://cdn.kashkick.com/offers/LgCVDi0a4mzC.jpg",
"square_image": null,
"large_image": "https://cdn.kashkick.com/offers/GqqR2lYZjy9z.jpg",
"card_text": "Start your 30 day trial with Albert to earn your Test Account dev reward.",
"amount": 5,
"cpa": 60,
"amount_currency": "$",
"url": "https://wall-aws-staging.besitos.ai/api-redirect/CwI606dZ/GU1TASHFZgtI/615441a1-38ce-4022-adcb-552cf542afb3?partner_user_id=",
"description": "<p><span style=\"color: rgb(45, 62, 80);\">Albert is building a world in which no one, regardless of income or net worth, has to worry about making the wrong financial decisions.</span></p><p><span style=\"color: rgb(45, 62, 80);\">Try Albert for 30 days before you’re charged. Plans start at $9.99/mo. Fees auto-renew until canceled. Cancel in the app. Terms apply. Offer applies to new users only.</span></p><p><strong style=\"color: rgb(59, 64, 66); background-color: rgb(255, 255, 255);\">Download Albert, link a bank account and start your 30 day trial to earn your Test Account dev reward!</strong></p>",
"details": "<p>*New Users Only.</p><p><span style=\"color: rgb(66, 63, 72); background-color: transparent;\">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.</span></p>",
"points": [
{
"title": "Download Albert, link a bank account and start your 30 day trial to earn your Kashkick reward!"
},
{
"title": "Albert budgets for you automatically and tracks your spending. Get your first budget in minutes."
},
{
"title": "Get alerted to rising bills, subscriptions you forgot about, and hidden fees. Spend less, save more."
}
],
"goals": [
{
"goal_id": "GU1TASHFZgtI_0",
"amount": 0,
"cpa": "0.00",
"text": "Install",
"days_left": null,
"goal_type": "linear",
"section": "linear",
"position": 1
},
{
"goal_id": "GU1TASHFZgtI_12265",
"amount": 5,
"cpa": "60.00",
"text": "Get approved",
"days_left": null,
"goal_type": "linear",
"section": "linear",
"position": 2
}
],
"budget_status": "Active",
"categories": [
{
"name": "Banking"
}
],
"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,
"amount_currency": "$",
"url": "https://wall-aws-staging.besitos.ai/api-redirect/CwI606dZ/tcInbmRITlAA/615441a1-38ce-4022-adcb-552cf542afb3?partner_user_id=",
"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
}
],
"budget_status": "Active",
"categories": [
{
"name": "Investing"
}
],
"state_filter": {
"type": "exclude",
"states": [
"AL",
"GA"
]
}
}
],
"links": {
"first": "https://wall-aws-staging.besitos.ai/data/partner/deals/CwI606dZ?page=1",
"last": "https://wall-aws-staging.besitos.ai/data/partner/deals/CwI606dZ?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-aws-staging.besitos.ai/data/partner/deals/CwI606dZ?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "https://wall-aws-staging.besitos.ai/data/partner/deals/CwI606dZ",
"per_page": 1000,
"to": 4,
"total": 4
}
}Response attributes
Attributes with a * must be displayed for users because they identify key earning requirements, such as operating system limitations and the number of days a user has to complete the offer.
Attributes | Data Type | Description | Example |
Deal |
|
|
|
| string | Include or exclude offers by state.
States must be in two-letter abbreviation format. |
or
or
|
| string | Unique identifier for the offer. | |
| string | Short promotional text for the offer. | |
| string | Title of the offer. |
|
| string | Offer image layout types and location (URL). |
|
| string | Additional promotional text. |
|
| integer | The user’s earnings (points, coins, or dollars) for completing the goal. If you’ve set your currency, the value will reflect that currency; otherwise, it will be in USD. | |
| float | The total amount you (the partner) can earn in USD. | |
| string | Your currency type, if specified; otherwise, USD. |
|
| string | Directs the user to the deal with these parameters:
Note: The URL expires after 30 minutes. Keep it updated to avoid broken links. |
|
| string | Description of the offer |
|
| string | Guidelines for completing the offer. | |
Goals |
|
|
|
| string | ID of a goal in the offer |
|
| integer | 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. |
|
| float | The amount you (the partner) earn in USD when the user completes this goal.
This amount corresponds to the value returned for | |
| string | Short description of the goal |
|
| 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. | |
| string | A "linear" goal must be completed in a specific order.
A "non-linear" goal can be completed at any time during the offer. | |
| string | Determines which section of the timeline the goal will be displayed in.
"Linear" goals must be completed in a specific order. | |
| string | The position (order) of the goal on the offer timeline. | |
Budget |
|
|
|
| string | The budget value can be "Active" or "Exhausted."
If the budget is "Exhausted," no more budget is available for new users that day. The budget will reset the next day, making the offer available to new users. | |
Category |
|
|
|
| string | The name of the category the deal is in. |
|
For help, contact your Besitos Account Manager or our Implementation Team at [email protected] or via your project channel in Slack.