Skip to main content
POST
Registra um clique via snippet JS (público)

Body

application/json
token
string
required

Token público do link de afiliado que originou o clique. Identifica programa, afiliado e destino.

Pattern: ^[a-z0-9-]{3,50}$
Example:

"rp_abc123"

sub
string

Sub-identificador livre (subId) repassado pelo afiliado para segmentar a origem do clique. Propagado para a conversão.

Required string length: 1 - 120
Example:

"campanha-natal"

referrer
string<uri>

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

Example:

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

visitorId
string

Identificador do visitante já conhecido (cookie first-party). Se ausente, um novo visitante é criado.

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

"vis_01J9Z3K8YQ4N2T7B6F0X1A2C3D"

Response

Default Response

tracked
enum<boolean>
required

Sempre false: indica que o clique NÃO foi registrado.

Available options:
false
reason
enum<string>
required

Motivo de não rastrear: affiliate_pending (afiliado ainda não aprovado) ou program_archived (programa arquivado).

Available options:
affiliate_pending,
program_archived