Esquemas de dados: Análise e regras de pesquisa

Esquemas de dados: Análise e regras de pesquisa. Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

Esquemas de dados

Metadados da resposta

AnalyticsMeta · Esquema · Esquemas de dados: Análise e regras de pesquisa

periodAnalyticsPeriodData Obrigatório: Período do relatório e seus limites.

Exemplo: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idTextoObrigatório: Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100

Exemplo: "example"

Campos adicionais: Não

Período do relatório e seus limites

AnalyticsPeriodData · Esquema · Esquemas de dados: Análise e regras de pesquisa

as_ofTextoObrigatório: Momento ao qual os dados apresentados se referem.

format: "date-time"

Exemplo: "2026-01-02T00:00:00Z"
daysNúmero inteiroObrigatório: Período do relatório em dias.

Exemplo: 1
started_atTextoObrigatório: Data e hora de início.

format: "date-time"

Exemplo: "2026-01-01T00:00:00Z"

Campos adicionais: Não

Listar · Consultas — Análise e regras de pesquisa — Resposta

AnalyticsResponse_list_MetricData__ · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

dataLista <MetricData > Obrigatório: Exemplo de resposta · AnalyticsResponse_list_MetricData__.

Exemplo: [{"clicks":1,"last_seen_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","searches":1,"zero_results":1}]
metaAnalyticsPageMeta AnalyticsMeta Obrigatório: Metadados da resposta.

Exemplo: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"period":{"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"},"request_id":"example"}

Campos adicionais: Não

Obter · Consultas — Análise e regras de pesquisa — Resposta

AnalyticsResponse_list_OccurrenceData__ · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

dataLista <OccurrenceData > Obrigatório: Exemplo de resposta · AnalyticsResponse_list_OccurrenceData__.

Exemplo: [{"category_id":"example","category_result_count":1,"currency_code":"PLN","is_zero_results":false,"locale_code":"en","market_id":"example","max_price":"0.00","min_price":"0.00","occurred_at":"2026-01-01T12:00:00Z","page":1,"product_result_count":1,"query_display":"example","request_id":"example","results":[{"clicked":false,"entity_id":"example","entity_type":"product","image_url":"https://example.invalid/product.jpg","number":"example","placement_source":"organic","position":1,"sku":"example","slug":"example","title":"example"}],"sort_key":"example","source":"results"}]
metaAnalyticsPageMeta AnalyticsMeta Obrigatório: Metadados da resposta.

Exemplo: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"period":{"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"},"request_id":"example"}

Campos adicionais: Não

Resumo — Análise e regras de pesquisa — Resposta

AnalyticsResponse_OverviewData_ · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

dataOverviewData Obrigatório: Exemplo de resposta · OverviewData.

Exemplo: {"click_through_rate":0,"clicked_searches":1,"recent":[{"is_zero_results":false,"locale_code":"en","occurred_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","request_id":"example","result_count":1,"source":"results"}],"searches":1,"zero_result_rate":0,"zero_results":1}
metaAnalyticsPageMeta AnalyticsMeta Obrigatório: Metadados da resposta.

Exemplo: {"period":{"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"},"request_id":"example"}

Campos adicionais: Não

Listar · Regras — Análise e regras de pesquisa — Resposta

ApiResponse_list_RuleSummaryData__ · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

dataLista <RuleSummaryData > Obrigatório: Exemplo de resposta · ApiResponse_list_RuleSummaryData__.

Exemplo: [{"created_at":"2026-01-01T12:00:00Z","enabled":true,"id":"example","is_available":true,"market_scope":"all","name":"Example","updated_at":"2026-01-01T12:00:00Z","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório: Metadados da resposta.

Exemplo: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Campos adicionais: Não

Obter · Regras — Análise e regras de pesquisa — Resposta

ApiResponse_RuleDetailData_ · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

dataRuleDetailData Obrigatório: Exemplo de resposta · RuleDetailData.

Exemplo: {"category_ids":["example"],"created_at":"2026-01-01T12:00:00Z","enabled":true,"id":"example","is_available":true,"market_ids":["example"],"market_scope":"all","name":"Example","phrase_groups":[{"locale":"en","phrases":["example"]}],"product_ids":["example"],"updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório: Metadados da resposta.

Exemplo: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Campos adicionais: Não

Listar · Consultas — Análise e regras de pesquisa — Resposta

MetricData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

clicksNúmero inteiroObrigatório: Número de cliques.

Exemplo: 1
last_seen_atTextoObrigatório: Momento da ocorrência mais recente.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"
query_displayTextoObrigatório: Frase de pesquisa exibida ao administrador.

Exemplo: "example"
query_hashTextoObrigatório: Identificador estável da frase de pesquisa agrupada.

Exemplo: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
searchesNúmero inteiroObrigatório: Número de pesquisas.

Exemplo: 1
zero_resultsNúmero inteiroObrigatório: Número de pesquisas sem resultados.

Exemplo: 1

Campos adicionais: Não

Obter · Consultas — Análise e regras de pesquisa — Resposta

OccurrenceData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

category_idTexto nullObrigatório

Identificador da categoria.

Exemplo: "example"

category_result_countNúmero inteiroObrigatório

Número de resultados de categorias.

Exemplo: 1

currency_codeTextoObrigatório

Código da moeda.

Exemplo: "PLN"

is_zero_resultsBooleanoObrigatório

Indica se a pesquisa não retornou resultados.

Exemplo: false

locale_codeTextoObrigatório

Código do idioma.

Exemplo: "en"

market_idTextoObrigatório

Identificador do mercado retornado pelo endpoint de contexto.

Exemplo: "example"

max_priceTexto nullObrigatório

Preço máximo do intervalo apresentado.

Exemplo: "0.00"

min_priceTexto nullObrigatório

Preço mínimo do intervalo apresentado.

Exemplo: "0.00"

occurred_atTextoObrigatório

Data e hora do evento.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"

pageNúmero inteiroObrigatório

Informações da página CMS.

Exemplo: 1

product_result_countNúmero inteiroObrigatório

Número de resultados de produtos na pesquisa.

Exemplo: 1

query_displayTextoObrigatório

Frase de pesquisa exibida ao administrador.

Exemplo: "example"

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

Exemplo: "example"

resultsLista <ResultSnapshotData > nullObrigatório

Resultados de pesquisa registados.

Exemplo:

[{"clicked":false,"entity_id":"example","entity_type":"product","image_url":"https://example.invalid/product.jpg","number":"example","placement_source":"organic","position":1,"sku":"example","slug":"example","title":"example"}]

sort_keyTextoObrigatório

Chave de ordenação.

Exemplo: "example"

sourceTextoObrigatório

Origem da atividade registada.

Restrições

enum: ["results", "autocomplete"]

Exemplo: "results"

Campos adicionais: Não

Resumo — Análise e regras de pesquisa — Resposta

OverviewData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

click_through_rateNúmeroObrigatório: Taxa de cliques dos dados de pesquisa selecionados.

Exemplo: 0
clicked_searchesNúmero inteiroObrigatório: Número de pesquisas com clique.

Exemplo: 1
recentLista <RecentSearchData > Obrigatório: Informações de pesquisas recentes.

Exemplo: [{"is_zero_results":false,"locale_code":"en","occurred_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","request_id":"example","result_count":1,"source":"results"}]
searchesNúmero inteiroObrigatório: Número de pesquisas.

Exemplo: 1
zero_result_rateNúmeroObrigatório: Proporção de pesquisas sem resultados.

Exemplo: 0
zero_resultsNúmero inteiroObrigatório: Número de pesquisas sem resultados.

Exemplo: 1

Campos adicionais: Não

Ordenação selecionada para os resultados

QueryMetricSort · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

Texto

Restrições

enum: ["last_seen_desc", "last_seen_asc", "searches_desc", "searches_asc", "clicks_desc", "clicks_asc"]

Campos adicionais: Sim

Informações de pesquisas recentes

RecentSearchData · Esquema · Esquemas de dados: Análise e regras de pesquisa

is_zero_resultsBooleanoObrigatório

Indica se a pesquisa não retornou resultados.

Exemplo: false

locale_codeTextoObrigatório

Código do idioma.

Exemplo: "en"

occurred_atTextoObrigatório

Data e hora do evento.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"

query_displayTextoObrigatório

Frase de pesquisa exibida ao administrador.

Exemplo: "example"

query_hashTextoObrigatório

Identificador estável da frase de pesquisa agrupada.

Exemplo: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

Exemplo: "example"

result_countNúmero inteiroObrigatório

Número de resultados de pesquisa.

Exemplo: 1

sourceTextoObrigatório

Origem da atividade registada.

Restrições

enum: ["results", "autocomplete"]

Exemplo: "results"

Campos adicionais: Não

Resultados de pesquisa registados

ResultSnapshotData · Esquema · Esquemas de dados: Análise e regras de pesquisa

clickedBooleanoObrigatório

Indica se o resultado recebeu um clique.

Exemplo: false

entity_idTextoObrigatório

Identificador da entidade referenciada.

Exemplo: "example"

entity_typeTextoObrigatório

Tipo da entidade referenciada.

Restrições

enum: ["product", "category"]

Exemplo: "product"

image_urlTexto nullObrigatório

URL da imagem.

Exemplo: "https://example.invalid/product.jpg"

numberTexto nullObrigatório

Número do pedido ou da solicitação exibido ao utilizador.

Exemplo: "example"

placement_sourceTextoObrigatório

Origem a partir da qual o pedido foi realizado.

Restrições

enum: ["organic", "merchandising"]

Exemplo: "organic"

positionNúmero inteiroObrigatório

Posição na coleção ordenada.

Exemplo: 1

skuTextoObrigatório

Código da unidade de manutenção de stock.

Exemplo: "example"

slugTextoObrigatório

Segmento do caminho da URL no idioma selecionado.

Exemplo: "example"

titleTextoObrigatório

Título no idioma selecionado.

Exemplo: "example"

Campos adicionais: Não

Criar · Regras — Análise e regras de pesquisa — Corpo da requisição

RuleCreate · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

category_idsLista <Texto> Opcional

Identificadores das categorias relacionadas.

maxItems: 100

Lista:minLength: 1maxLength: 63

enabledBooleanoOpcional

Indica se esta configuração está ativada.

Predefinido: false

market_idsLista <Texto> Opcional

Identificadores dos mercados selecionados.

maxItems: 1000

Lista:minLength: 1maxLength: 63

market_scopeTextoOpcional

Indica se o recurso se aplica a todos os mercados ou apenas aos selecionados.

Restrições

enum: ["all", "selected"]

nameTextoObrigatório

Nome do recurso no contexto correspondente.

minLength: 1maxLength: 160

Exemplo: "Example"

phrasesLista <Texto> Obrigatório

Frases utilizadas pela regra de pesquisa.

minItems: 1maxItems: 20

Lista:minLength: 1maxLength: 255

Exemplo: ["example"]

product_idsLista <Texto> Opcional

Identificadores dos produtos relacionados.

maxItems: 100

Lista:minLength: 1maxLength: 63

Exemplo: ["example"]

Campos adicionais: Não

Obter · Regras — Análise e regras de pesquisa — Resposta

RuleDetailData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

category_idsLista <Texto> Obrigatório

Identificadores das categorias relacionadas.

Exemplo: ["example"]

created_atTextoObrigatório

Momento da criação.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"

enabledBooleanoObrigatório

Indica se esta configuração está ativada.

Exemplo: true

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado. (RuleDetailData).

Exemplo: "example"

is_availableBooleanoObrigatório

Indica se o item está disponível neste contexto.

Exemplo: true

market_idsLista <Texto> Obrigatório

Identificadores dos mercados selecionados.

Exemplo: ["example"]

market_scopeTextoObrigatório

Indica se o recurso se aplica a todos os mercados ou apenas aos selecionados.

Restrições

enum: ["all", "selected"]

Exemplo: "all"

nameTextoObrigatório

Nome do recurso no contexto correspondente.

Exemplo: "Example"

phrase_groupsLista <RulePhraseGroupData > Obrigatório

Grupos de frases das regras de pesquisa.

Exemplo: [{"locale":"en","phrases":["example"]}]

product_idsLista <Texto> Obrigatório

Identificadores dos produtos relacionados.

Exemplo: ["example"]

updated_atTextoObrigatório

Momento da atualização mais recente.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"

versionNúmero inteiroObrigatório

Versão do recurso utilizada para controlo de concorrência.

Exemplo: 1

Campos adicionais: Não

Grupos de frases das regras de pesquisa

RulePhraseGroupData · Esquema · Esquemas de dados: Análise e regras de pesquisa

localeTextoObrigatório: Idioma selecionado para esta requisição.

Exemplo: "en"
phrasesLista <Texto> Obrigatório: Frases utilizadas pela regra de pesquisa.

Exemplo: ["example"]

Campos adicionais: Não

Listar · Regras — Análise e regras de pesquisa — Resposta

RuleSummaryData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

created_atTextoObrigatório

Momento da criação.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"

enabledBooleanoObrigatório

Indica se esta configuração está ativada.

Exemplo: true

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado. (RuleSummaryData).

Exemplo: "example"

is_availableBooleanoObrigatório

Indica se o item está disponível neste contexto.

Exemplo: true

market_scopeTextoObrigatório

Indica se o recurso se aplica a todos os mercados ou apenas aos selecionados.

Restrições

enum: ["all", "selected"]

Exemplo: "all"

nameTextoObrigatório

Nome do recurso no contexto correspondente.

Exemplo: "Example"

updated_atTextoObrigatório

Momento da atualização mais recente.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"

versionNúmero inteiroObrigatório

Versão do recurso utilizada para controlo de concorrência.

Exemplo: 1

Campos adicionais: Não

Atualizar · Regras — Análise e regras de pesquisa — Corpo da requisição

RuleUpdate · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

category_idsLista <Texto> Opcional

Identificadores das categorias relacionadas.

maxItems: 100

Lista:minLength: 1maxLength: 63

enabledBooleanoOpcional

Indica se esta configuração está ativada.

expected_versionNúmero inteiroObrigatório

Versão lida antes da escrita; uma divergência rejeita a atualização.

minimum: 1maximum: 2147483647

Exemplo: 1

market_idsLista <Texto> Opcional

Identificadores dos mercados selecionados.

maxItems: 1000

Lista:minLength: 1maxLength: 63

market_scopeTextoOpcional

Indica se o recurso se aplica a todos os mercados ou apenas aos selecionados.

Restrições

enum: ["all", "selected"]

nameTextoOpcional

Nome do recurso no contexto correspondente.

minLength: 1maxLength: 160

Exemplo: "Example"

phrasesLista <Texto> Opcional

Frases utilizadas pela regra de pesquisa.

maxItems: 20

Lista:minLength: 1maxLength: 255

product_idsLista <Texto> Opcional

Identificadores dos produtos relacionados.

maxItems: 100

Lista:minLength: 1maxLength: 63

Campos adicionais: Não

Filtro de pesquisas com ou sem ocorrências sem resultados

ZeroResultScope · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

Texto

Restrições

enum: ["all", "has_zero_results", "no_zero_results"]

Campos adicionais: Sim