Table of Contents | ||
---|---|---|
|
Updated:
1. Get started
API token can be retrieved on the “Account->Api Settings” page.
...
Name | Values | Description | ||||||
status | success, error | Request status | ||||||
message | Success or error message | |||||||
count | Number of results in response (in data array) | |||||||
totalCount | Number of total results | |||||||
totalPages | Number of available pages (according to used limit value) | |||||||
page | Current page number | |||||||
data | List of offers | |||||||
data.*.id | Offer id | |||||||
data.*.website_url | Offer website preview link | |||||||
data.*.status | Offer status | |||||||
data.*.category | Offer category | |||||||
data.*.category.name | Offer category name | |||||||
data.*.geo | Countries, in which this offer is available | |||||||
| *source_id required to get tracking link Tracking link or error message if something went wrong. Errors list:
| |||||||
data.*.type | Offer types | |||||||
data.*.payout | Offer payout description | |||||||
data.*.short_payout | Offer short payout description | |||||||
data.*.hold_period | Hold periods. Number of days | |||||||
data.*.cookie_lifetime | Cookie lifetime in days | |||||||
data.*.deeplink | true/false | offer deeplink | ||||||
data.*.hold_period | hold period | |||||||
data.*.cookie_lifetime | cookie lifetime | |||||||
data.*.cookie_lifetime_is_hours | true/false | Determine if the cookie lifetime is in hours (true) or not (false) | ||||||
data.*.traffic_restrictions | Offer traffic restriction | |||||||
data.*.traffic_restrictions.*.name | Traffic restriction name | |||||||
data.*.traffic_restrictions.*.status | allowed, forbiden, need approval | Traffic restriction status | ||||||
data.*.logo | Offer logo link | |||||||
data.*.banners | List of offer banners | |||||||
data.*.banners.*.size | Banner size (e.g. "100-120" => width 100px, height 120px) | |||||||
data.*.banners.*.file | Banner file name | |||||||
data.*.banners.*.link | Banner download link | |||||||
data.*.landing_pages | List of offer landing pages | |||||||
data.*.landing_pages.*.id | Landing page id | |||||||
data.*.landing_pages.*.title | Landing page title (name) | |||||||
data.*.landing_pages.*.preview_url | Landing page URL |
...
Name | Values | Description | ||||||
total | Number of total offers | |||||||
per_page | Number of data limit in one page | |||||||
current_page | Number of current page | |||||||
last_page | Number of last page | |||||||
first_page_url | URL for first page | |||||||
last_page_url | URL for last page | |||||||
next_page_url | URL for next page | |||||||
prev_page_url | URL for previous page | |||||||
path | Path of URL | |||||||
from | Number of first data in current page | |||||||
to | Number of last data in current page | |||||||
data | List of offers | |||||||
data.title | offer name | |||||||
data.type | cps, cpl, etc. | |||||||
data.deleted_at | ||||||||
data.id_thumbnail | ||||||||
data.advertiser_id | ||||||||
data.geo | ||||||||
data.short_payout | ||||||||
data.preview_url | ||||||||
data.cr | conversions rate | |||||||
data.category_id | ||||||||
data.created_at | ||||||||
data.overage | ||||||||
data.visibility | active, need approval, private, testing | Offer visibility rules: private - private offer, available for particular publishers only. testing - an offer that is used for testing or it’s integration with Indoleads is in progress. | ||||||
| bool | * Used only if visibility is ‘need approval' | ||||||
data.applied | bool | * Used only if visibility is 'need approval' The field has TRUE If Publisher applied to the offer and the application is pending, FALSE - if application was approved, rejected or doesn’t exists. | ||||||
data.rejected | bool | * Used only if visibility is 'need approval' The field has TRUE If Publisher`s application to the offer was rejected, FALSE - if publisher doesn’t applied to the offer or the application is pending or approved. | ||||||
data.blocked | bool | Displays if user was banned for using the offer. | ||||||
data.active | bool | |||||||
data.advertiser | ||||||||
data.traffic_restrictions | ||||||||
data.caps |
...
Route: /getCoupons
Type: GET
Desc: API response may contain coupons related to the offers with NeedApproval visibility regardless of application status.
Fields:
Name | Values | Description |
id | Offer id | |
short_description | Offer title | |
description | Offer website preview link | |
discount | Offer logo link | |
discount_type | percent, | Offer types |
geo | Country codes | |
start_duration | ||
end_duration | ||
code | ||
offer | ||
offer.id | ||
offer.title | ||
offer.logo | ||
offer.short_desc | ||
offer.geo | ||
offer.type | ||
offer.payout |
...
4.1. Get publisher's sources types
Route: /getPublisherSourcesTypes/{publisher_id}
Type: GET
Parameters:
...