{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/autocompletes/popular","auth":"required","results":{"codes":[{"status":200,"language":"json","code":"HTTP/1.1 200\n{\n    \"requestId\": \"ee00ee85-62ea-467b-887c-489fae6c7de4\",\n    \"searchId\": \"ee00ee85-62ea-467b-887c-489fae6c7de4\",\n    \"queries\": [\n        {\n            \"query\": \"vestidos\",\n            \"link\": \"/engage/search/v3/search?origin=autocomplete&apikey=apikey&terms=vestidos&ranking=1&topsearch=1\"\n        },\n        {\n            \"query\": \"vestido\",\n            \"link\": \"/engage/search/v3/search?origin=autocomplete&apikey=apikey&terms=vestido&ranking=2&topsearch=1\"\n        },\n        {\n            \"query\": \"jeans\",\n            \"link\": \"/engage/search/v3/search?origin=autocomplete&apikey=apikey&terms=jeans&ranking=3&topsearch=1\"\n        },\n        {\n            \"query\": \"calca feminina\",\n            \"link\": \"/engage/search/v3/search?origin=autocomplete&apikey=apikey&terms=calca+feminina&ranking=4&topsearch=1\"\n        },\n        {\n            \"query\": \"blusa feminina\",\n            \"link\": \"/engage/search/v3/search?origin=autocomplete&apikey=apikey&terms=blusa+feminina&ranking=5&topsearch=1\"\n        },\n        {\n            \"query\": \"calca\",\n            \"link\": \"/engage/search/v3/search?origin=autocomplete&apikey=apikey&terms=calca&ranking=6&topsearch=1\"\n        },\n        {\n            \"query\": \"blusa\",\n            \"link\": \"/engage/search/v3/search?origin=autocomplete&apikey=apikey&terms=blusa&ranking=7&topsearch=1\"\n        },\n        {\n            \"query\": \"blusas\",\n            \"link\": \"/engage/search/v3/search?origin=autocomplete&apikey=apikey&terms=blusas&ranking=8&topsearch=1\"\n        },\n        {\n            \"query\": \"vestido feminino\",\n            \"link\": \"/engage/search/v3/search?origin=autocomplete&apikey=apikey&terms=vestido+feminino&ranking=9&topsearch=1\"\n        },\n        {\n            \"query\": \"saia\",\n            \"link\": \"/engage/search/v3/search?origin=autocomplete&apikey=apikey&terms=saia&ranking=10&topsearch=1\"\n        }\n    ]\n}","name":""},{"status":404,"language":"json","code":"HTTP/1.1 404 Not Found\n{\n \"message\": \"Not found\"\n}","name":""},{"language":"json","code":"HTTP/1.1 401 Unauthorized\n{\n    \"code\": 1008,\n    \"message\": \"Invalid Secret Key\"\n}","status":401},{"status":400,"language":"json","code":"HTTP/1.1 400 Bad Request\n{\n \"message\": \"Invalid request: missing parameters\"\n}"},{"status":500,"language":"json","code":"HTTP/1.1 500 Internal Server Error\n{\n \"message\": \"Error: Internal Server Error\"\n}"}]},"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":"58bda2cd8bcd092f00e52857"},{"name":"secretkey","type":"string","default":"","desc":"Não sabe qual a secretKey da sua loja? Solicite ao responsável técnico de integração enviando um email para [email protected]","required":true,"in":"query","ref":"","_id":"592edd3aa5cc09002fb60e01"},{"name":"deviceId","type":"string","default":"","desc":"Identificador único do device.","required":false,"in":"query","ref":"","_id":"5da96ad137639e0011067bae"},{"name":"userId","type":"string","default":"","desc":"Id do usuário. Deve ser o mesmo identificador utilizado no site.","required":false,"in":"query","ref":"","_id":"5da96ad137639e0011067bad"}],"examples":{"codes":[]},"method":"get"},"next":{"description":"","pages":[]},"title":"/autocompletes/popular","type":"endpoint","slug":"autocomplete-popular","excerpt":"O Autocomplete com Termos Populares mostra, antes da digitação no campo de consulta, termos populares pesquisados na loja. Esta requisição normalmente é utilizada no momento do clique no campo de busca.","body":"<h3>Como fazer a consulta?</h3>\nPara realizar uma consulta, utilize diretamente a rota\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.linximpulse.com/engage/search/v3/autocompletes/popular?apiKey=<loja>&secretKey=<secretKey>\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n<h3>Como é a resposta?</h3>\nAs consultas retornadas estarão no campo **queries**, e as respectivas request em **link**\n\n**Importante**: Lembre-se de manter os parâmetros `&ranking=10&topsearch=1` na subsequênte request para /search conforme [Regras da Coleta de Dados](doc:coleta-de-dados)","updates":[],"order":5,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5d00029d39c2920014e31712","createdAt":"2017-03-06T15:28:59.091Z","parentDoc":null,"githubsync":"","user":"5760739a30e27d0e00002a9f","project":"55c3572a57f7f32d0016ec3d","__v":9,"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"},"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"}}

get/autocompletes/popular

O Autocomplete com Termos Populares mostra, antes da digitação no campo de consulta, termos populares pesquisados na loja. Esta requisição normalmente é utilizada no momento do clique no campo de busca.

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]
secretkey:
required
string
Não sabe qual a secretKey da sua loja? Solicite ao responsável técnico de integração enviando um email para [email protected]
deviceId:
string
Identificador único do device.
userId:
string
Id do usuário. Deve ser o mesmo identificador utilizado no site.

Result Format


Documentation

<h3>Como fazer a consulta?</h3> Para realizar uma consulta, utilize diretamente a rota [block:code] { "codes": [ { "code": "https://api.linximpulse.com/engage/search/v3/autocompletes/popular?apiKey=<loja>&secretKey=<secretKey>", "language": "curl" } ] } [/block] <h3>Como é a resposta?</h3> As consultas retornadas estarão no campo **queries**, e as respectivas request em **link** **Importante**: Lembre-se de manter os parâmetros `&ranking=10&topsearch=1` na subsequênte request para /search conforme [Regras da Coleta de Dados](doc:coleta-de-dados)

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 }}