Page Comparison

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:
error: source_id is required to get tracking link URL - in case if source_id is not provided or empty.

error: tracking links available only for publishers - if request is send by user with role different from publisher.

error: invalid source_id value provided - if provided source_id is not exists or related to the other account.

error: source type is restricted by offer rules - source type of the source provided in request is not listed in the Offer traffic restrictions rules.

error: source type is forbidden by offer rules - some offers may forbid different traffic sources. Please check the Offer traffic restrictions section to select the source correctly.

error: please apply to the offer to get tracking link - in case if the Offer has “need approval“ visibility, and application to the Offer is required to work with that Offer.

error: you application to the offer is pending - if publisher`s application to the offer is created but pending (awaiting for approval).

error: you application to the offer is rejected, contact to you manager to get details - if publishers`s application to use the Offer was rejected.

error: unknown problem, please contact support to get more details - unknown problem that requires investigation.

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:
active - visible for all.
need approval - publishers have to apply to the offer and get approval to use it. Application status is described in allowed, applied and rejected fields.

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'
The field has TRUE If Publisher`s application to the offer was approved, FALSE - if publisher doesn’t applied to the offer or his application is pending or rejected.

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