Skip to main content
POST
/
public
/
addlinkvisit
Add a link visit
curl --request POST \
  --url https://api.joylink.io/public/addlinkvisit \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "link_key": "<string>",
  "os": "<string>",
  "city": "<string>",
  "device": "<string>",
  "region": "<string>",
  "browser": "<string>",
  "country": "<string>",
  "referrer": "<string>",
  "referrerURL": "<string>",
  "country_code": "<string>",
  "user_agent": "<string>",
  "ip_address": "<string>",
  "link_not_found_behavior": {
    "create_link": true,
    "create_link_input": {
      "destination": "<string>",
      "trackingid": "<string>"
    }
  }
}'
{
  "success": true,
  "link": {
    "key": "<string>",
    "description": "<string>",
    "destination": "<string>",
    "imageUrl": "<string>",
    "productTitle": "<string>",
    "userId": "<string>",
    "linkPrefix": "<string>",
    "createdAt": "<string>"
  }
}

Authorizations

X-API-Key
string
header
required

Body

application/json

The link key to track

os
string

Operating system

city
string

City name

device
string

Device type

region
string

Region

browser
string

Browser name

country
string

Country name

referrer
string

Referrer

referrerURL
string

Referrer URL

country_code
string

Country code

user_agent
string

User agent string

ip_address
string

IP address

Response

Successfully recorded link visit

success
boolean