Get offer’s information
HTTP method
Endpoint
GET
/aff/v1/offers

Path parameters

Parameter
Description
all
All offers.
personal
Personal offers.

Query string parameters

Conditions
Parameters
Type
Description
type
type
type
Possible Values: all · personal
Offset
offset
offset
Check page scale.
Limit
limit
limit
The number of date displays in each page. Maximum = 200
Sort
sort
sort
Ranking according to the specified field ascending "+", or descending "-".Only id sorting is supported.
Filters
filters
filter
Query requirements of Specify field.
EQUAL_TO NOT_EQUAL_TO LESS_THAN LESS_THAN_OR_EQUAL_TO GREATER_THAN GREATER_THAN_OR_EQUAL_TO
Fields
fields
field
You can choose the field of the query (the result of the query is in line with the selected field).
id
integer
A string that uniquely identifies this offer.
name
string
The name of the this Offer
end_date
integer
The expiration date of the Offer.
status
string
The current status of the offer.
pricing_type
string
The current pricing_type of the offer. Possible Values: CPA · CPI · CPM · CPC · CPS · CPA+CPS
payout
string
The payout of the offer.
percent_payout
string
Percent payout.
preview_url
string
URL that often skips any geo-targeting or other re-targeting implemented by the Offer URL. Allows Affiliates to view sample landing page.
thumbnail
string
The offer’s thumbnail of the link address.
category
string
The category of the offer (categroy means the tag information).
offer_approval
integer
Whether this Offer requires manual approval before an Affiliate can run it. Possible Values: 1 Require Approval 2 Public 3 Private
tracking_link
string
Tracking link. NOTE: tracking link can be acquired only in the case of Personal Offer.
currency
string
The currency of the Offer.
conversion_protocol
integer
The Conversion tracking method to use for the Offer. Possible Values: 1:Image Pixel; 2:Postback URL; 3:iFrame Pixel
app_id
string
the App ID on app store or google play
event
object
Offer event.
Contains
contains
string
List of related objects to return with each result.
description
string
A description for the Offer. Default does not return, if needed, by the following ways. For example,contains=description
EPC1
string
Offers can be pulled according to EPC, for example,contains=EPC1,EPC1 means offers is pulled according to EPC of today
EPC2
string
EPC2 means offers is pulled according to EPC of yesterday
EPC3
string
EPC3 means offers is pulled according to EPC of last three days
EPC4
string
EPC4 means offers is pulled according to EPC of last 7 days
CR1
string
Offers can be pulled according to CR, for example,contains=CR1,CR1 means offers is pulled according to CR of today
CR2
string
CR2 means offers is pulled according to CR of yesterday
CR3
string
CR3 means offers is pulled according to CR of last three days
CR4
string
CR4 means offers is pulled according to CR of last 7 days

Response body parameters

Field
Type
Description
id
integer
A string that uniquely identifies this offer.
name
string
The name of the this Offer
end_date
integer
The expiration date of the Offer.
status
string
The current status of the offer.
pricing_type
string
The current pricing_type of the offer. Possible Values: CPA·CPM·CPI·CPC·CPS·CPA+CPS
payout
string
The payout of the offer.
preview_url
string
URL that often skips any geo-targeting or other re-targeting implemented by the Offer URL. Allows Affiliates to view sample landing page.
description
string
A description for the Offer.
thumbnail
string
The offer’s thumbnail of the link address.
category
string
The category of the offer.
offer_approval
integer
Whether this Offer requires manual approval before an Affiliate can run it.
tracking_link
string
Tracking link. NOTE: tracking link can be acquired only in the case of Personal Offer.
currency
string
The currency of the Offer.
conversion_protocol
integer
The Conversion tracking method to use for the Offer. Possible Values: 1:Image Pixel; 2:Postback URL; 3:iFrame Pixel
event
object
Offer event.
impression_pixel
string
impression pixel. NOTE: impression_pixel link can be acquired only in the case of Personal Offer.
carrier
array
Mobile Carrier
app_id
string
the App ID on app store or google play
browser
array
Browser
totalPages
integer
The list of data pages (associated with your limit).
totalRows
integer
Total number of available data.
offset
integer
The number of records from a collection to skip. Iterating over large collections with this parameter can be slow.
limit
integer
The number of data displayed on one page.

Example request

Example response

1
{
2
"code": 0,
3
"message": "Success",
4
"data": {
5
"rowset": [
6
{
7
"id": 15,
8
"category": "test",
9
"offer_approval": 2,
10
"tracking_link": "http://click.dev.offerslook.com:9080/index.php?offer_id=15&aff_id=161",
11
"end_date": 1493999999,
12
"pricing_type": "CPA",
13
"payout": "1",
14
"percent_payout": "-1",
15
"preview_url": "https://www.offerslook.com/",
16
"currency": "USD",
17
"conversion_protocol": 2,
18
"app_id": "871125783",
19
"impression_pixel": "<img src='http://qoqololo.iuniontrack.com:9080/impr.php?offer_id=15&aff_id=161' border='0' width='1' height='1' />",
20
"carrier": [],
21
"browser": [
22
"Chrome",
23
"360 Browser",
24
"Amaya"
25
],
26
"event": [
27
{
28
"event_id": 1,
29
"event_name": "Initial Event",
30
"event_payout_type": "CPA",
31
"event_payout": "1.000",
32
"event_percent_payout": "-1",
33
"conversion_protocol": 2
34
},
35
{
36
"event_id": 2,
37
"event_name": "TEST",
38
"event_payout_type": "CPA+CPS",
39
"event_payout": "2.000",
40
"event_percent_payout": "10",
41
"conversion_protocol": 3
42
}
43
]
44
},
45
{
46
"id": 17,
47
"category": "test",
48
"offer_approval": 1,
49
"tracking_link": "",
50
"end_date": 1493999999,
51
"pricing_type": "CPS",
52
"payout": "-1",
53
"percent_payout": "2",
54
"preview_url": "https://www.offerslook.com/",
55
"currency": "USD",
56
"conversion_protocol": 2,
57
"event": [
58
{
59
"event_id": 1,
60
"event_name": "Initial Event",
61
"event_payout_type": "CPS",
62
"event_payout": "-1",
63
"event_percent_payout": "2",
64
"conversion_protocol": 2
65
}
66
]
67
},
68
{
69
"id": 18,
70
"category": "test",
71
"offer_approval": 1,
72
"tracking_link": "",
73
"end_date": 1493999999,
74
"pricing_type": "CPC",
75
"payout": "2",
76
"percent_payout": "-1",
77
"preview_url": "https://offerslook.gitbooks.io/api-documentation/content/index.html",
78
"currency": "USD",
79
"conversion_protocol": 1,
80
"event": [
81
{
82
"event_id": 1,
83
"event_name": "Initial Event",
84
"event_payout_type": "CPC",
85
"event_payout": "2",
86
"event_percent_payout": "-1",
87
"conversion_protocol": 2
88
}
89
]
90
}
91
],
92
"totalPages": 2,
93
"totalRows": 13,
94
"offset": 2,
95
"limit": 10
96
}
97
}
Copied!
Last modified 1yr ago