Create click

Create click

curl --request POST \
  --url https://{domain}/api/v2/network/tracker/click \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "affiliate_id": 1,
  "offer_id": 1,
  "ip": "203.0.113.77",
  "link_id": 1,
  "source_id": 1,
  "creative_id": 1
}
'

import requests

url = "https://{domain}/api/v2/network/tracker/click"

payload = {
    "affiliate_id": 1,
    "offer_id": 1,
    "ip": "203.0.113.77",
    "link_id": 1,
    "source_id": 1,
    "creative_id": 1
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    affiliate_id: 1,
    offer_id: 1,
    ip: '203.0.113.77',
    link_id: 1,
    source_id: 1,
    creative_id: 1
  })
};

fetch('https://{domain}/api/v2/network/tracker/click', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{domain}/api/v2/network/tracker/click",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'affiliate_id' => 1,
    'offer_id' => 1,
    'ip' => '203.0.113.77',
    'link_id' => 1,
    'source_id' => 1,
    'creative_id' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{domain}/api/v2/network/tracker/click"

	payload := strings.NewReader("{\n  \"affiliate_id\": 1,\n  \"offer_id\": 1,\n  \"ip\": \"203.0.113.77\",\n  \"link_id\": 1,\n  \"source_id\": 1,\n  \"creative_id\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{domain}/api/v2/network/tracker/click")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"affiliate_id\": 1,\n  \"offer_id\": 1,\n  \"ip\": \"203.0.113.77\",\n  \"link_id\": 1,\n  \"source_id\": 1,\n  \"creative_id\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{domain}/api/v2/network/tracker/click")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"affiliate_id\": 1,\n  \"offer_id\": 1,\n  \"ip\": \"203.0.113.77\",\n  \"link_id\": 1,\n  \"source_id\": 1,\n  \"creative_id\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "code": 200,
  "name": "OK",
  "message": "Click transaction has been added successfully!",
  "info": {
    "click_id": "<string>"
  }
}

{
  "message": "Request could not be parsed.",
  "success": false,
  "info": {
    "errors": {}
  }
}

{
  "message": "API key is invalid or missing.",
  "success": false
}

{
  "message": "This endpoint is not available for your role.",
  "success": false
}

{
  "message": "Validation error",
  "success": false,
  "info": {
    "errors": {
      "email": [
        "Email cannot be blank."
      ],
      "currency": [
        "Currency must be a valid ISO code."
      ]
    }
  }
}

{
  "message": "An unexpected error occurred.",
  "success": false,
  "info": {
    "errors": {}
  }
}

POST

api

network

tracker

click

Create click

curl --request POST \
  --url https://{domain}/api/v2/network/tracker/click \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "affiliate_id": 1,
  "offer_id": 1,
  "ip": "203.0.113.77",
  "link_id": 1,
  "source_id": 1,
  "creative_id": 1
}
'

import requests

url = "https://{domain}/api/v2/network/tracker/click"

payload = {
    "affiliate_id": 1,
    "offer_id": 1,
    "ip": "203.0.113.77",
    "link_id": 1,
    "source_id": 1,
    "creative_id": 1
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    affiliate_id: 1,
    offer_id: 1,
    ip: '203.0.113.77',
    link_id: 1,
    source_id: 1,
    creative_id: 1
  })
};

fetch('https://{domain}/api/v2/network/tracker/click', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{domain}/api/v2/network/tracker/click",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'affiliate_id' => 1,
    'offer_id' => 1,
    'ip' => '203.0.113.77',
    'link_id' => 1,
    'source_id' => 1,
    'creative_id' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{domain}/api/v2/network/tracker/click"

	payload := strings.NewReader("{\n  \"affiliate_id\": 1,\n  \"offer_id\": 1,\n  \"ip\": \"203.0.113.77\",\n  \"link_id\": 1,\n  \"source_id\": 1,\n  \"creative_id\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{domain}/api/v2/network/tracker/click")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"affiliate_id\": 1,\n  \"offer_id\": 1,\n  \"ip\": \"203.0.113.77\",\n  \"link_id\": 1,\n  \"source_id\": 1,\n  \"creative_id\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{domain}/api/v2/network/tracker/click")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"affiliate_id\": 1,\n  \"offer_id\": 1,\n  \"ip\": \"203.0.113.77\",\n  \"link_id\": 1,\n  \"source_id\": 1,\n  \"creative_id\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "code": 200,
  "name": "OK",
  "message": "Click transaction has been added successfully!",
  "info": {
    "click_id": "<string>"
  }
}

{
  "message": "Request could not be parsed.",
  "success": false,
  "info": {
    "errors": {}
  }
}

{
  "message": "API key is invalid or missing.",
  "success": false
}

{
  "message": "This endpoint is not available for your role.",
  "success": false
}

{
  "message": "Validation error",
  "success": false,
  "info": {
    "errors": {
      "email": [
        "Email cannot be blank."
      ],
      "currency": [
        "Currency must be a valid ISO code."
      ]
    }
  }
}

{
  "message": "An unexpected error occurred.",
  "success": false,
  "info": {
    "errors": {}
  }
}

Authorizations

X-API-Key

string

header

required

Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.

Body

application/json

affiliate_id

integer

required

Affiliate ID.

offer_id

integer

required

Offer ID.

string

Visitor IP address. Both IPv4 and IPv6 are accepted, e.g. 203.0.113.77 or 2001:db8:85a3::8a2e:370:7334. The value is normalised rather than kept verbatim: an ::ffff: prefix is stripped on input, IPv4 is held in IPv6-mapped form, and IPv6 is stored in ClickHouse binary IPv6, so an uppercase or fully expanded address comes back canonical and lowercase. An unparseable value is silently stored as :: with a 200. A truncated copy such as 203.0.xxx.xxx is stored alongside regardless of settings, and while the platform GDPR hide-IP setting is on the full address is replaced with :: and the reporting endpoints return that truncated mask instead. Used for geo-attribution.

advertiser_id

integer

Ignored on input - resolved from the offer.

goal_id

integer

Ignored on input - the CPC goal is resolved from the offer.

link_id

integer

Landing page (offer URL) id. When omitted and creative_id is set, the landing page of that creative is used; otherwise the offer default applies.

source_id

integer

Affiliate traffic source id; validated against the affiliate's own sources.

creative_id

integer

Creative id; validated against the offer's creatives.

user_agent

string

Client user agent; parsed for device, OS and browser detection.

click_referer

string

HTTP referrer URL.

country_id

integer

Not stored on the click - the click country always comes from the ip lookup. A supplied value is only used for the CPC commission lookup, so sending one can price the click for a country the click itself does not carry.

redirect_url

string

Ignored on input - not listed in the model rules, so it is dropped before the click is built.

sub_id1

string

Affiliate sub id 1, stored on the click and available in reports.

sub_id2

string

Affiliate sub id 2, stored on the click and available in reports.

sub_id3

string

Affiliate sub id 3, stored on the click and available in reports.

sub_id4

string

Affiliate sub id 4, stored on the click and available in reports.

sub_id5

string

Affiliate sub id 5, stored on the click and available in reports.

aff_param1

string

Affiliate custom parameter 1, stored on the click.

aff_param2

string

Affiliate custom parameter 2, stored on the click.

aff_param3

string

Affiliate custom parameter 3, stored on the click.

aff_param4

string

Affiliate custom parameter 4, stored on the click.

aff_param5

string

Affiliate custom parameter 5, stored on the click.

aff_click_id

string

Affiliate's own click identifier.

deep_link

string

Deep link value stored on the click.

idfa

string

iOS device identifier.

gaid

string

Android device identifier.

click_date

string<date-time>

Click timestamp (defaults to now).

hash

string

MD5 click hash for uniqueness validation (32 hex chars).

custom1

string

Custom tracking value 1, stored on the click.

custom2

string

Custom tracking value 2, stored on the click.

custom3

string

Custom tracking value 3, stored on the click.

custom4

string

Custom tracking value 4, stored on the click.

custom5

string

Custom tracking value 5, stored on the click.

custom6

string

Custom tracking value 6, stored on the click.

custom7

string

Custom tracking value 7, stored on the click.

custom8

string

Custom tracking value 8, stored on the click.

custom9

string

Custom tracking value 9, stored on the click.

custom10

string

Custom tracking value 10, stored on the click.

Response

Click created.

status

string

Example:

"success"

code

integer

Example:

200

name

string

Example:

"OK"

message

string

Example:

"Click transaction has been added successfully!"

info

object

Show child attributes

Getting started

Manager

Affiliate

Advertiser

Reference

Authorizations

Body

Response