Skip to main content
POST
Create a click

Authorizations

Authorization
string
header
required

Tolt API key sent as a bearer token.

Body

application/json

Identify the click by one of link_id, partner_id, or param and value together. A request with none of them, or with only one of param and value, returns 400.

The link that was clicked. The partner and program are taken from it.

Minimum string length: 1
Example:

"lnk_7bYqA2"

partner_id
string

The partner who generated the click. Use it when you know the partner but not the link.

Minimum string length: 1
Example:

"part_9fQ2xLL"

param
string

The tracking parameter of the link, e.g. ref. Send it with value when all you have is the landing URL.

Minimum string length: 1
Example:

"ref"

value
string

The value of the tracking parameter, e.g. sam in ?ref=sam.

Minimum string length: 1
Example:

"sam"

country
string

Two-letter ISO country code where the click originated.

Required string length: 2
Example:

"US"

device
string

Device type, e.g. desktop, mobile or tablet.

Minimum string length: 1
Example:

"desktop"

page
string

URL of the page the visitor landed on.

Minimum string length: 1
Example:

"https://acme.com/pricing"

referrer
string

URL of the referring page.

Minimum string length: 1
Example:

"https://twitter.com"

Response

The created click

success
boolean
required
Example:

true

message
string
required
Example:

"Request successful"

data
object
required