Termos Populares

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.

Como fazer a consulta?

Para realizar uma consulta, utilize diretamente a rota:

curl
curl -v -G "https://api.linximpulse.com/engage/search/v3/autocompletes/popular" \
  -d apiKey="<my-apikey>" \
  -d secretKey="<my-secret-key>"

Padrão de Resposta

As consultas retornadas estarão no campo queries, e as respectivas requests em link.

Importante: Lembre-se de manter os parâmetros &ranking=10&topsearch=1 na subsequente request para /search conforme Regras da Coleta de Dados

Query Params

apiKey
stringrequired

ID interno de identificação da sua loja.

Não sabe qual a apiKey da sua loja? Solicite ao responsável técnico de integração enviando um email para suporteimpulse@linx.com.br

secretKey
stringrequired

Chave de acesso para autenticar a requisição. Pode ser substituída pelo parâmetro origin quando a requisição é feita via frontend para não expor a chave.

Não sabe qual a secretKey da sua loja? Solicite ao responsável técnico de integração enviando um email para suporteimpulse@linx.com.br

deviceId
stringrequired

Identificador único do dispositivo. Todas as requisições feitas a partir do mesmo dispositivo devem possuir o mesmo deviceId.

source
stringrequired

Origem do dispositivo utilizado. Os tipos padrões são:
  • desktop
  • mobile
  • app
Novos canais podem ser criados no Dashboard da Busca, caso os canais padrões não atendam a necessidade.
Caso um valor inválido seja informado, irá impactar o registro de métricas de desempenho e KPIs da solução de busca.

origin
string

Define a URL de origem da requisição. Pode ser usada no lugar da secretKey para autenticar a requisição.

salesChannel
string

ID de canais de vendas. Para consultar mais de um canal, insira um campo adicional.

hide
string

Desativa retorno de campos na resposta. Por padrão todos os campos são ativos. Para incluir mais de uma opção, insira um campo adicional.Valores permitidos:
  • products
  • quickFilters
  • banners
  • adSearches
  • suggestions
  • filters

productFormat
string default: relevance

Define o formato de resposta dos produtos. Por padrão todos os campos são ativos.Valores permitidos:
  • onlyIds
  • complete
  • compact

userId
string

Id do usuário. Deve ser o mesmo identificador utilizado no site. (Quando o usuário estiver logado)

Edit this page on GitHub
Typescript
const fetch = require('node-fetch');

const url = 'https://api.linximpulse.com/engage/search/v3/autocompletes/popular';
const options = {method: 'GET', headers: {accept: 'application/json'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
curl
curl -v -G "https://api.linximpulse.com/engage/search/v3/autocompletes/popular" \
  -d apiKey="<my-apikey>" \
  -d secretKey="<my-secret-key>"
Full Response
{
  "requestId": "e6e97269-1da2-4f3d-9728-e222c713cdb2",
  "searchId": "e6e97269-1da2-4f3d-9728-e222c713cdb2",
  "queries": [
    {
      "query": "celular",
      "link": "/engage/search/v3/search?origin=autocomplete&apikey=<my-api-key>&terms=celular&ranking=1&topsearch=1"
    },
    {
      "query": "geladeira",
      "link": "/engage/search/v3/search?origin=autocomplete&apikey=<my-api-key>&terms=geladeira&ranking=2&topsearch=1"
    },
    {
      "query": "tv",
      "link": "/engage/search/v3/search?origin=autocomplete&apikey=<my-api-key>&terms=tv&ranking=3&topsearch=1"
    },
    {
      "query": "ar condicionado",
      "link": "/engage/search/v3/search?origin=autocomplete&apikey=<my-api-key>&terms=ar+condicionado&ranking=5&topsearch=1"
    },
    {
      "query": "guarda roupa",
      "link": "/engage/search/v3/search?origin=autocomplete&apikey=<my-api-key>&terms=guarda+roupa&ranking=6&topsearch=1"
    },
    {
      "query": "fogao",
      "link": "/engage/search/v3/search?origin=autocomplete&apikey=<my-api-key>&terms=fogao&ranking=7&topsearch=1"
    }
  ],
  "products": [
    {
      "id": "1080329"
    },
    {
      "id": "1123069"
    },
    {
      "id": "1123087"
    },
    {
      "id": "1123089"
    },
    {
      "id": "1124173"
    }
  ]
}