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 · CPL · 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·CPL·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 |
carrier_mode | integer | carrier_mode indicates the Mobile Carrier type.1 indicates include. 2 indicates exclude. |
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
Last updated