Páginas Populares

Pages é responsável por gerar URLs amigáveis para campanhas específicas e acompanhamento de métricas sem a interferência nos resultados da busca interna na loja. Ou seja, é um mecanismo automático de indexação de links para geração de tráfego orgânico. Esta requisição é utilizada para obter a lista de urls de consultas populares, separadas por letra inicial e por consultas.

Como fazer a consulta?

Você pode utilizar diretamente a rota para retornar consultas para todas as letras, ou mesmo filtrar por uma letra específica:

All Pages
curl -v -G "https://api.linximpulse.com/engage/search/v3/pages" \
  -d apiKey="<my-apikey>" \
  -d secretKey="<my-secret-key>"
By Letter
curl -v -G "https://api.linximpulse.com/engage/search/v3/pages" \
  -d apiKey="<my-apikey>" \
  -d secretKey="<my-secret-key>" \
  -d letter=a

Padrão de Resposta

As consultas são separadas por letra no campo letters, e por consultas no campo queries.

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

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.

letter
string

Filtro de letra das consultas contidas na lista.

origin
string

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

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:
  • queries
  • letters

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

const url = 'https://api.linximpulse.com/engage/search/v3/pages';
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/pages" \
  -d apiKey="<my-apikey>" \
  -d secretKey="<my-secret-key>"
Full Response
{
  "searchId": "f9bb101b-f1dc-4b14-884a-2e0e0a5185c3",
  "requestId": "f9bb101b-f1dc-4b14-884a-2e0e0a5185c3",
  "letters": {
      "numeric": [],
      "a": [
          {
              "query": "alfaiataria",
              "link": "/searchapi/v3/search?apikey=<my-api-key>&origin=seo&terms=alfaiataria"
          },
          {
              "query": "azul",
              "link": "/searchapi/v3/search?apikey=<my-api-key>&origin=seo&terms=azul"
          },
          {
              "query": "alfaiataria+feminina",
              "link": "/searchapi/v3/search?apikey=<my-api-key>&origin=seo&terms=alfaiataria+feminina"
          }
      ],
      "b": [
          {
              "query": "body",
              "link": "/searchapi/v3/search?apikey=<my-api-key>&origin=seo&terms=body"
          },
          {
              "query": "blusa",
              "link": "/searchapi/v3/search?apikey=<my-api-key>&origin=seo&terms=blusa"
          },
          {
              "query": "blusas+femininas",
              "link": "/searchapi/v3/search?apikey=<my-api-key>&origin=seo&terms=blusas+femininas"
          }
      ],
      "c": [
          {
              "query": "cropped",
              "link": "/searchapi/v3/search?apikey=<my-api-key>&origin=seo&terms=cropped"
          },
          {
              "query": "calca",
              "link": "/searchapi/v3/search?apikey=<my-api-key>&origin=seo&terms=calca"
          },
          {
              "query": "calca+jeans",
              "link": "/searchapi/v3/search?apikey=<my-api-key>&origin=seo&terms=calca+jeans"
          }
      ]
  },
  "queries": [
      {
          "query": "cropped",
          "link": "/searchapi/v3/search?apikey=<my-api-key>&origin=seo&terms=cropped"
      },
      {
          "query": "vestido",
          "link": "/searchapi/v3/search?apikey=<my-api-key>&origin=seo&terms=vestido"
      },
      {
          "query": "feminino",
          "link": "/searchapi/v3/search?apikey=<my-api-key>&origin=seo&terms=feminino"
      },
      {
          "query": "saia",
          "link": "/searchapi/v3/search?apikey=<my-api-key>&origin=seo&terms=saia"
      },
      {
          "query": "calca",
          "link": "/searchapi/v3/search?apikey=<my-api-key>&origin=seo&terms=calca"
      }
  ]
}