Click API v3
That feature available only for PRO or higher editions
Click API is an interface for receiving the result of running the campaign and their streams. To manage your campaigns and receive reports see Admin API.
Other Versions
Difference Between v2 and v3
- Offer in a stream do not perform action, it returns only
info.token
. To make action performed you must sendforce_redirect_offer=1
. - Added
cookies_ttl
.
Token
To make a request to API you must send “token” to the campaign. You can take it from the campaign editing page, tab “Additional Settings”.
API URL Prefix
/click_api/v3
Request Example
curl "http://keitarotds.soft.project/click_api/v3?token=ebd928ea"
Parameters
All parameters described here which_parameters_can_i_pass_for_the_reports and listed below.
- ip — IP address of the IPv4 type
- user_agent
- language
- landing_id
- uniqueness_cookie — current contents of the cookie
- log — if you need the log of a click processing (1 or 0)
- info — return info block (1 or 0)
- force_redirect_offer — performs offer direct if it is chosen (1 or 0)
Response
Response is returned in JSON format. Its attributes are:
Attribute | Type | Description |
---|---|---|
headers | array | Array of header responses |
body | string | Body of the response (for example, the page text) |
contentType | string | Response type (In the case of json it is “application/json; charset=utf-8”) |
uniqueness_cookie | string | Cookie that you must send in further requests to Click API |
cookies_ttl | int | How many hours to store cookies on website side |
log | array | Contents of the click processing log |
info | object | Container with information by click |
info.sub_id | string | |
info.campaign_id | int | |
info.stream_id | int | |
info.landing_id | int | |
info.offer_id | array | |
info.token | string | |
info.uniqueness | array | |
info.uniqueness.campaign | boolean | |
info.uniqueness.stream | boolean | |
info.uniqueness.global | boolean | |
info.is_bot | boolean |
Response
curl "http://tracker.com/click_api/v3?token=ebd928ea&log=1&info=1"
{ "body": null, "contentType": "text/html; charset=utf-8", "headers": [ "Location: http://domain.com/?data=&utm-campaign=aff1" ], "info": { "campaign_id": 2, "stream_id": 1117, "sub_id": "o2q6e42hs08jq", "type": "location", "url": "http://domain.com/?data=$keyword&utm-campaign=aff1" }, "log": [ "Processing campaign 2", "Referrer: ", "Source: ", "Keyword: ", "IP: 127.0.0.1", "UserAgent: HTTPie/0.6.0", "Language: ", "Is unique in campaign: no", "Checking stream #1282", "Filter \"uniqueness\": allow", "Filter \"uniqueness\": rejected", "Checking stream #1343", "Filter \"region\": rejected", "Checking stream #1355", "Filter \"limit\": allow", "Filter \"ip\": rejected", "Checking stream #1117", "Accepted by filters", "Stream #1117", "Send headers: Location: http://domain.com/?data=&utm-campaign=aff1", "[Profiler] 0.101 sec. 1 sql queries, 9MB (+7MB)" ], "uniqueness_cookie": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjoie1wic3RyZWFtc1wiOntcIjExMTdcIjoxNDkwNzA1MTQyfSxcImNhbXBhaWduc1wiOntcIjJcIjoxNDkwNzA1MTQyfSxcInRpbWVcIjoxNDkwNzA1MTQyfSJ9._u5H9oOOdyp02VTnDN8VG47oLDoqRHHKyYI3ChxRqw8" }
Click API Client
Read the page Click API Client.