Consulta um clique

GET

clicks

{clickId}

Consulta um clique

curl --request GET \
  --url https://api.userepass.com/clicks/{clickId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.userepass.com/clicks/{clickId}', 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://api.userepass.com/clicks/{clickId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.userepass.com/clicks/{clickId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.userepass.com/clicks/{clickId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "clk_01J9Z3K8YQ4N2T7B6F0X1A2C3D",
  "organizationId": "org_01J9Z3K8YQ4N2T7B6F0X1A2C3D",
  "programId": "prog_01J9Z3K8YQ4N2T7B6F0X1A2C3D",
  "affiliateId": "aff_01J9Z3K8YQ4N2T7B6F0X1A2C3D",
  "linkId": "link_01J9Z3K8YQ4N2T7B6F0X1A2C3D",
  "visitorId": "vis_01J9Z3K8YQ4N2T7B6F0X1A2C3D",
  "fingerprint": "<string>",
  "ip": "203.0.113.0",
  "ipTruncatedAt": "2026-06-13T12:00:00.000Z",
  "country": "BR",
  "region": "SP",
  "city": "São Paulo",
  "userAgent": "<string>",
  "device": {
    "deviceType": "mobile",
    "browser": "Chrome",
    "os": "Android"
  },
  "referrer": "https://blog.exemplo.com/post",
  "subId": "campanha-natal",
  "bot": false,
  "convertedAt": "2026-06-13T12:30:00.000Z",
  "occurredAt": "2026-06-13T12:00:00.000Z",
  "expiresAt": "2026-07-13T12:00:00.000Z",
  "createdAt": "2026-06-13T12:00:00.000Z"
}

Authorizations

Authorization

string

header

required

Chave de API (prefixo rstr_) enviada como Authorization: Bearer rstr_....

Path Parameters

clickId

string

required

Identificador do clique.

Pattern: ^clk_[0-9A-HJKMNP-TV-Z]{26}$

Example:

"clk_01J9Z3K8YQ4N2T7B6F0X1A2C3D"

Response

200 - application/json

Default Response

string

required

Identificador único do clique.

Example:

"clk_01J9Z3K8YQ4N2T7B6F0X1A2C3D"

organizationId

string

required

Organização dona do clique.

Example:

"org_01J9Z3K8YQ4N2T7B6F0X1A2C3D"

programId

string

required

Programa de afiliados associado ao clique.

Example:

"prog_01J9Z3K8YQ4N2T7B6F0X1A2C3D"

affiliateId

string

required

Afiliado que originou o clique.

Example:

"aff_01J9Z3K8YQ4N2T7B6F0X1A2C3D"

linkId

string

required

Link de afiliado clicado.

Example:

"link_01J9Z3K8YQ4N2T7B6F0X1A2C3D"

visitorId

string

required

Visitante (cookie first-party) que realizou o clique.

Example:

"vis_01J9Z3K8YQ4N2T7B6F0X1A2C3D"

fingerprint

string | null

required

Impressão digital do dispositivo, quando disponível.

string | null

required

Endereço IP do visitante, anonimizado por privacidade (ver ipTruncatedAt).

Example:

"203.0.113.0"

ipTruncatedAt

string<date-time> | null

required

Data em que o IP foi truncado/anonimizado por privacidade; nulo se não truncado.

Example:

"2026-06-13T12:00:00.000Z"

country

string | null

required

País resolvido por GeoIP a partir do IP.

Example:

"BR"

region

string | null

required

Região/estado resolvido por GeoIP.

Example:

"SP"

city

string | null

required

Cidade resolvida por GeoIP.

Example:

"São Paulo"

userAgent

string | null

required

User-agent bruto do clique.

device

object | null

required

Dados de dispositivo derivados do user-agent.

Show child attributes

referrer

string | null

required

URL de origem (referrer) da página onde o clique ocorreu.

Example:

"https://blog.exemplo.com/post"

subId

string | null

required

Sub-identificador livre (subId) repassado pelo afiliado.

Example:

"campanha-natal"

bot

boolean

required

Indica se o clique foi classificado como tráfego de bot.

Example:

false

botReason

enum<string> | null

required

Motivo da classificação como bot; nulo quando não é bot.

Available options:

user_agent,

ip_blocklist

source

enum<string>

required

Origem do clique: redirect (capturado no redirecionamento 302 de /t/{token}) ou script (capturado pelo snippet JS via /track/click).

Available options:

redirect,

script

convertedAt

string<date-time> | null

required

Data em que o clique gerou conversão; nulo se ainda não converteu.

Example:

"2026-06-13T12:30:00.000Z"

occurredAt

string<date-time>

required

Data/hora em que o clique ocorreu (ISO-8601).

Example:

"2026-06-13T12:00:00.000Z"

expiresAt

string<date-time>

required

Data de expiração da janela de atribuição do clique: após essa data o clique não pode mais ser creditado a uma conversão.

Example:

"2026-07-13T12:00:00.000Z"

createdAt

string<date-time>

required

Data de criação do registro de clique.

Example:

"2026-06-13T12:00:00.000Z"

Consulta um clique

curl --request GET \
  --url https://api.userepass.com/clicks/{clickId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.userepass.com/clicks/{clickId}', 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://api.userepass.com/clicks/{clickId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.userepass.com/clicks/{clickId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.userepass.com/clicks/{clickId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "clk_01J9Z3K8YQ4N2T7B6F0X1A2C3D",
  "organizationId": "org_01J9Z3K8YQ4N2T7B6F0X1A2C3D",
  "programId": "prog_01J9Z3K8YQ4N2T7B6F0X1A2C3D",
  "affiliateId": "aff_01J9Z3K8YQ4N2T7B6F0X1A2C3D",
  "linkId": "link_01J9Z3K8YQ4N2T7B6F0X1A2C3D",
  "visitorId": "vis_01J9Z3K8YQ4N2T7B6F0X1A2C3D",
  "fingerprint": "<string>",
  "ip": "203.0.113.0",
  "ipTruncatedAt": "2026-06-13T12:00:00.000Z",
  "country": "BR",
  "region": "SP",
  "city": "São Paulo",
  "userAgent": "<string>",
  "device": {
    "deviceType": "mobile",
    "browser": "Chrome",
    "os": "Android"
  },
  "referrer": "https://blog.exemplo.com/post",
  "subId": "campanha-natal",
  "bot": false,
  "convertedAt": "2026-06-13T12:30:00.000Z",
  "occurredAt": "2026-06-13T12:00:00.000Z",
  "expiresAt": "2026-07-13T12:00:00.000Z",
  "createdAt": "2026-06-13T12:00:00.000Z"
}