GETRelatório de buscas

O que os clientes buscam na loja: termos mais usados, buscas sem resultado e buscas sem clique.

Mostra o desempenho da busca interna da loja num intervalo. Os termos sem resultado revelam produtos que os clientes procuram e a loja não tem (ou sinônimos que faltam); os termos sem clique indicam resultados ruins. Use from e to para escolher o intervalo; sem eles, vale os últimos 30 dias.

GET/api/v1/admin/analytics/searchAdmin

Relatório da busca interna

Parâmetros de consulta

fromstring

Primeiro dia, YYYY-MM-DD. Padrão: 30 dias atrás. Valor inválido é ignorado em silêncio.

tostring

Último dia, YYYY-MM-DD, inclusive. Padrão: agora. Valor inválido é ignorado em silêncio.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/analytics/search?from=2026-09-01&to=2026-10-10" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Relatório retornado

json

{
  "summary": { "searches": 37, "zero_result_rate_bps": 270, "ctr_bps": 0, "conversion_bps": 0 },
  "top_terms": [
    { "term": "cadeira", "count": 4, "ctr_bps": 0 }
  ],
  "zero_results": [
    { "term": "zzxqwplkj", "count": 1 }
  ],
  "no_click": [
    { "term": "cadeira", "count": 4 }
  ]
}

Campos da resposta

summaryobject

Totais do intervalo.

summary.searchesinteger

Buscas realizadas.

summary.zero_result_rate_bpsinteger

Parcela de buscas sem resultado, em pontos-base (270 = 2,70%).

summary.ctr_bpsinteger

Parcela de buscas que geraram clique em um produto, em pontos-base.

summary.conversion_bpsinteger

Parcela de buscas que terminaram em compra, em pontos-base.

top_termsarray

Termos mais buscados, com term, count e ctr_bps.

zero_resultsarray

Termos que não encontraram nada, com term e count.

no_clickarray

Termos buscados cujos resultados nunca foram clicados, com term e count.

Erros

Status	Quando	Corpo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem o privilégio exigido.	`{"error":"insufficient privileges","required":"view_reports"}`
403	O módulo está desligado na loja.	`{"error":"module_disabled","module":"analytics"}`
503	Serviço de busca indisponível na loja.	`{"error":"search analytics unavailable"}`
500	Falha ao consultar os dados.	`{"error":"failed to ..."}`

Veja também