{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/clicks","auth":"required","results":{"codes":[{"status":200,"language":"json","code":"{\n\trequestId: \"022ab6fb8ee02c4ef45ff6638b94c2bea289276d\",\n\tsearchId: \"022ab6fb8ee02c4ef45ff6638b94c2bea289276d\",\n\tstatus: \"ok\"\n}","name":""},{"status":400,"language":"json","code":"{\n\tcode: 1001,\n\tmessage: \"Missing parameter \"deviceId\"\"\n}","name":""}]},"settings":"58bd78f5816ab10f00d45fd6","params":[{"name":"apikey","type":"string","default":"","desc":"Não sabe qual a apiKey da sua loja? Solicite ao responsável técnico de integração enviando um email para atendimento:::at:::chaordic.com.br","required":true,"in":"query","ref":"","_id":"5c25234be438370238737d36"},{"name":"trackingId","type":"string","default":"","desc":"Campo fornecido pelo resultado da busca.","required":true,"in":"query","ref":"","_id":"5c25234be438370238737d34"},{"name":"deviceId","type":"string","default":"","desc":"Identificador único do dispositivo utiilizado.","required":true,"in":"query","ref":"","_id":"5c25234be438370238737d33"},{"name":"source","type":"string","default":"","desc":"Dispositivo utilizado. Os tipos suportados são:  <ul> <li>desktop;</li> <li>mobile;</li> <li>app;</li> </ul>","required":true,"in":"query","ref":"","_id":"5c25234be438370238737d32"},{"name":"userId","type":"string","default":"","desc":"Id do usuário. Deve ser o mesmo identificador utilizado no site.","required":false,"in":"query","ref":"","_id":"5c25234be438370238737d31"},{"name":"interactionType","type":"string","default":"PRODUCT_VIEW","desc":"Tipo do clique. Os tipos suportados são:  <ul> <li>PRODUCT_VIEW; (default) </li> <li>ADD_TO_CART.</li> </ul> <br><b>Obs.: Campo obrigatório quando for ADD_TO_CART.</b></br>","required":false,"in":"query","ref":"","_id":"5c25234be438370238737d30"}],"examples":{"codes":[]},"method":"get"},"next":{"description":"","pages":[]},"title":"/clicks","type":"endpoint","slug":"clicks","excerpt":"Rota que representa a ação de clique em um produto do resultado da busca (busca textual, navigates, hotsites, autocompletes e pages) ou clique em \"adicionar ao carrinho\" em produtos do resultado da busca. Para cada produto do resultado de busca, há o campo \"clickUrl\" que já possui os parâmetros de apikey e trackingId. Ex: clickUrl: \"/search/v3/clicks?apiKey=<apikey>&trackingId=eyJzZWFyY2hJZCI...\"","body":"[block:api-header]\n{\n  \"title\": \"Tracking de eventos\"\n}\n[/block]\nCada produto do resultado da busca nas rotas /search, /autocompletes, /navigates, /hotsites contém um campo chamado **clickUrl**.\n\nEste campo fornece uma URL da API de Busca, na rota /clicks que deverá ser usada para registrar todos os eventos de click dos usuários da aplicação com os produtos do resultado da busca. É por meio destes registros que geramos métricas de performance da busca, além de melhorar as estratégias para acertar em cheio cada resultado.\n\nO deviceId é o identificador único do device do usuário e é usado pelo sistema para recuperar o histórico de visitas do usuário a fim de realizar o tracking de eventos da Busca. Por este motivo, é muito importante que o deviceId seja o mesmo em todos os eventos do mesmo usuário naquele device.\n\n# Atenção\nCaso a coleta de eventos seja realizada pelos nossos scripts, através do meta. É necessário que seja utilizado o campo correspondente de deviceId. Este campo é disponibilizado pelos scripts de coleta no domínio do lojista, no cookie **chaordic_browserId**.\n\nSe a coleta de eventos for chamada via API, o gerenciamento do deviceId deve ser feito pelo lojista.","updates":[],"order":12,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5d00029d39c2920014e3171f","project":"55c3572a57f7f32d0016ec3d","version":{"version":"3-search","version_clean":"3.0.0-search","codename":"API de Busca pelo time de Integração","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5d00029d39c2920014e316db","5d00029d39c2920014e316dc","5d00029d39c2920014e316dd","5d00029d39c2920014e316de","5d00029d39c2920014e316df","5d00029d39c2920014e316e0","5d00029d39c2920014e316e1","5d00029d39c2920014e316e2","5d00029d39c2920014e316e3","5d00029d39c2920014e316e4","5d00029d39c2920014e316e5","5d00029d39c2920014e316e6"],"_id":"5d00029d39c2920014e31722","project":"55c3572a57f7f32d0016ec3d","__v":0,"forked_from":"590a413d12d47a3700f83c8e","createdAt":"2017-05-03T20:44:45.480Z","releaseDate":"2017-05-03T20:44:45.480Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"API de busca","slug":"api-de-busca","order":8,"from_sync":false,"reference":false,"_id":"5d00029d39c2920014e316e3","project":"55c3572a57f7f32d0016ec3d","createdAt":"2017-03-06T13:18:21.954Z","__v":0,"version":"5d00029d39c2920014e31722"},"user":"5c250992c5bcb90290748b33","createdAt":"2018-12-27T17:46:12.008Z","__v":21,"parentDoc":null}

get/clicks

Rota que representa a ação de clique em um produto do resultado da busca (busca textual, navigates, hotsites, autocompletes e pages) ou clique em "adicionar ao carrinho" em produtos do resultado da busca. Para cada produto do resultado de busca, há o campo "clickUrl" que já possui os parâmetros de apikey e trackingId. Ex: clickUrl: "/search/v3/clicks?apiKey=<apikey>&trackingId=eyJzZWFyY2hJZCI..."

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

apikey:
required
string
Não sabe qual a apiKey da sua loja? Solicite ao responsável técnico de integração enviando um email para [email protected]
trackingId:
required
string
Campo fornecido pelo resultado da busca.
deviceId:
required
string
Identificador único do dispositivo utiilizado.
source:
required
string
Dispositivo utilizado. Os tipos suportados são: <ul> <li>desktop;</li> <li>mobile;</li> <li>app;</li> </ul>
userId:
string
Id do usuário. Deve ser o mesmo identificador utilizado no site.
interactionType:
stringPRODUCT_VIEW
Tipo do clique. Os tipos suportados são: <ul> <li>PRODUCT_VIEW; (default) </li> <li>ADD_TO_CART.</li> </ul> <br><b>Obs.: Campo obrigatório quando for ADD_TO_CART.</b></br>

Result Format


Documentation

[block:api-header] { "title": "Tracking de eventos" } [/block] Cada produto do resultado da busca nas rotas /search, /autocompletes, /navigates, /hotsites contém um campo chamado **clickUrl**. Este campo fornece uma URL da API de Busca, na rota /clicks que deverá ser usada para registrar todos os eventos de click dos usuários da aplicação com os produtos do resultado da busca. É por meio destes registros que geramos métricas de performance da busca, além de melhorar as estratégias para acertar em cheio cada resultado. O deviceId é o identificador único do device do usuário e é usado pelo sistema para recuperar o histórico de visitas do usuário a fim de realizar o tracking de eventos da Busca. Por este motivo, é muito importante que o deviceId seja o mesmo em todos os eventos do mesmo usuário naquele device. # Atenção Caso a coleta de eventos seja realizada pelos nossos scripts, através do meta. É necessário que seja utilizado o campo correspondente de deviceId. Este campo é disponibilizado pelos scripts de coleta no domínio do lojista, no cookie **chaordic_browserId**. Se a coleta de eventos for chamada via API, o gerenciamento do deviceId deve ser feito pelo lojista.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}