Esquemas de datos: Análisis y reglas de búsqueda

Esquemas de datos: Análisis y reglas de búsqueda. Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

Esquemas de datos

Metadatos de la respuesta

AnalyticsMeta · Esquema · Esquemas de datos: Análisis y reglas de búsqueda

periodAnalyticsPeriodData Obligatorio: Periodo del informe y sus límites.

Ejemplo: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idCadena de textoObligatorio: Identificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.

minLength: 1maxLength: 100

Ejemplo: "example"

Campos adicionales: No

Periodo del informe y sus límites

AnalyticsPeriodData · Esquema · Esquemas de datos: Análisis y reglas de búsqueda

as_ofCadena de textoObligatorio: Momento al que corresponden los datos indicados.

format: "date-time"

Ejemplo: "2026-01-02T00:00:00Z"
daysNúmero enteroObligatorio: Periodo del informe en días.

Ejemplo: 1
started_atCadena de textoObligatorio: Fecha y hora de inicio.

format: "date-time"

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

Campos adicionales: No

Listar · Consultas — Análisis y reglas de búsqueda — Respuesta

AnalyticsResponse_list_MetricData__ · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

dataLista <MetricData > Obligatorio: Ejemplo de respuesta · AnalyticsResponse_list_MetricData__.

Ejemplo: [{"clicks":1,"last_seen_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","searches":1,"zero_results":1}]
metaAnalyticsPageMeta AnalyticsMeta Obligatorio: Metadatos de la respuesta.

Ejemplo: {"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 adicionales: No

Obtener · Consultas — Análisis y reglas de búsqueda — Respuesta

AnalyticsResponse_list_OccurrenceData__ · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

dataLista <OccurrenceData > Obligatorio: Ejemplo de respuesta · AnalyticsResponse_list_OccurrenceData__.

Ejemplo: [{"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 Obligatorio: Metadatos de la respuesta.

Ejemplo: {"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 adicionales: No

Resumen — Análisis y reglas de búsqueda — Respuesta

AnalyticsResponse_OverviewData_ · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

dataOverviewData Obligatorio: Ejemplo de respuesta · OverviewData.

Ejemplo: {"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 Obligatorio: Metadatos de la respuesta.

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

Campos adicionales: No

Listar · Reglas — Análisis y reglas de búsqueda — Respuesta

ApiResponse_list_RuleSummaryData__ · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

dataLista <RuleSummaryData > Obligatorio: Ejemplo de respuesta · ApiResponse_list_RuleSummaryData__.

Ejemplo: [{"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 Obligatorio: Metadatos de la respuesta.

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

Campos adicionales: No

Obtener · Reglas — Análisis y reglas de búsqueda — Respuesta

ApiResponse_RuleDetailData_ · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

dataRuleDetailData Obligatorio: Ejemplo de respuesta · RuleDetailData.

Ejemplo: {"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 Obligatorio: Metadatos de la respuesta.

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

Campos adicionales: No

Listar · Consultas — Análisis y reglas de búsqueda — Respuesta

MetricData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

clicksNúmero enteroObligatorio: Número de clics.

Ejemplo: 1
last_seen_atCadena de textoObligatorio: Momento de la aparición más reciente.

format: "date-time"

Ejemplo: "2026-01-01T12:00:00Z"
query_displayCadena de textoObligatorio: Frase de búsqueda mostrada al administrador.

Ejemplo: "example"
query_hashCadena de textoObligatorio: Identificador estable de la frase de búsqueda agrupada.

Ejemplo: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
searchesNúmero enteroObligatorio: Número de búsquedas.

Ejemplo: 1
zero_resultsNúmero enteroObligatorio: Número de búsquedas sin resultados.

Ejemplo: 1

Campos adicionales: No

Obtener · Consultas — Análisis y reglas de búsqueda — Respuesta

OccurrenceData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

category_idCadena de texto nullObligatorio

Identificador de la categoría.

Ejemplo: "example"

category_result_countNúmero enteroObligatorio

Número de resultados de categorías.

Ejemplo: 1

currency_codeCadena de textoObligatorio

Código de la moneda.

Ejemplo: "PLN"

is_zero_resultsBooleanoObligatorio

Indica si la búsqueda no devolvió resultados.

Ejemplo: false

locale_codeCadena de textoObligatorio

Código del idioma.

Ejemplo: "en"

market_idCadena de textoObligatorio

Identificador del mercado devuelto por el endpoint de contexto.

Ejemplo: "example"

max_priceCadena de texto nullObligatorio

Precio máximo del intervalo indicado.

Ejemplo: "0.00"

min_priceCadena de texto nullObligatorio

Precio mínimo del intervalo indicado.

Ejemplo: "0.00"

occurred_atCadena de textoObligatorio

Fecha y hora del evento.

format: "date-time"

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

pageNúmero enteroObligatorio

Información de la página CMS.

Ejemplo: 1

product_result_countNúmero enteroObligatorio

Número de resultados de productos en la búsqueda.

Ejemplo: 1

query_displayCadena de textoObligatorio

Frase de búsqueda mostrada al administrador.

Ejemplo: "example"

request_idCadena de textoObligatorio

Identificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.

Ejemplo: "example"

resultsLista <ResultSnapshotData > nullObligatorio

Resultados de búsqueda registrados.

Ejemplo:

[{"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_keyCadena de textoObligatorio

Clave de ordenación.

Ejemplo: "example"

sourceCadena de textoObligatorio

Origen de la actividad registrada.

Restricciones

enum: ["results", "autocomplete"]

Ejemplo: "results"

Campos adicionales: No

Resumen — Análisis y reglas de búsqueda — Respuesta

OverviewData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

click_through_rateNúmeroObligatorio: Tasa de clics de los datos de búsqueda seleccionados.

Ejemplo: 0
clicked_searchesNúmero enteroObligatorio: Número de búsquedas con un clic.

Ejemplo: 1
recentLista <RecentSearchData > Obligatorio: Información de búsquedas recientes.

Ejemplo: [{"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 enteroObligatorio: Número de búsquedas.

Ejemplo: 1
zero_result_rateNúmeroObligatorio: Proporción de búsquedas sin resultados.

Ejemplo: 0
zero_resultsNúmero enteroObligatorio: Número de búsquedas sin resultados.

Ejemplo: 1

Campos adicionales: No

Orden seleccionado para los resultados

QueryMetricSort · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

Cadena de texto

Restricciones

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

Campos adicionales: Sí

Información de búsquedas recientes

RecentSearchData · Esquema · Esquemas de datos: Análisis y reglas de búsqueda

is_zero_resultsBooleanoObligatorio

Indica si la búsqueda no devolvió resultados.

Ejemplo: false

locale_codeCadena de textoObligatorio

Código del idioma.

Ejemplo: "en"

occurred_atCadena de textoObligatorio

Fecha y hora del evento.

format: "date-time"

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

query_displayCadena de textoObligatorio

Frase de búsqueda mostrada al administrador.

Ejemplo: "example"

query_hashCadena de textoObligatorio

Identificador estable de la frase de búsqueda agrupada.

Ejemplo: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idCadena de textoObligatorio

Identificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.

Ejemplo: "example"

result_countNúmero enteroObligatorio

Número de resultados de búsqueda.

Ejemplo: 1

sourceCadena de textoObligatorio

Origen de la actividad registrada.

Restricciones

enum: ["results", "autocomplete"]

Ejemplo: "results"

Campos adicionales: No

Resultados de búsqueda registrados

ResultSnapshotData · Esquema · Esquemas de datos: Análisis y reglas de búsqueda

clickedBooleanoObligatorio

Indica si se hizo clic en el resultado.

Ejemplo: false

entity_idCadena de textoObligatorio

Identificador de la entidad referenciada.

Ejemplo: "example"

entity_typeCadena de textoObligatorio

Tipo de la entidad referenciada.

Restricciones

enum: ["product", "category"]

Ejemplo: "product"

image_urlCadena de texto nullObligatorio

URL de la imagen.

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

numberCadena de texto nullObligatorio

Número de pedido o solicitud mostrado al usuario.

Ejemplo: "example"

placement_sourceCadena de textoObligatorio

Origen desde el que se realizó el pedido.

Restricciones

enum: ["organic", "merchandising"]

Ejemplo: "organic"

positionNúmero enteroObligatorio

Posición en la colección ordenada.

Ejemplo: 1

skuCadena de textoObligatorio

Código de referencia de inventario.

Ejemplo: "example"

slugCadena de textoObligatorio

Segmento de la ruta URL en el idioma seleccionado.

Ejemplo: "example"

titleCadena de textoObligatorio

Título en el idioma seleccionado.

Ejemplo: "example"

Campos adicionales: No

Crear · Reglas — Análisis y reglas de búsqueda — Cuerpo de la solicitud

RuleCreate · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

category_idsLista <Cadena de texto> Opcional

Identificadores de las categorías relacionadas.

maxItems: 100

Lista:minLength: 1maxLength: 63

enabledBooleanoOpcional

Indica si esta opción está habilitada.

Valor predeterminado: false

market_idsLista <Cadena de texto> Opcional

Identificadores de los mercados seleccionados.

maxItems: 1000

Lista:minLength: 1maxLength: 63

market_scopeCadena de textoOpcional

Indica si el recurso se aplica a todos los mercados o solo a los seleccionados.

Restricciones

enum: ["all", "selected"]

nameCadena de textoObligatorio

Nombre del recurso en el contexto correspondiente.

minLength: 1maxLength: 160

Ejemplo: "Example"

phrasesLista <Cadena de texto> Obligatorio

Frases utilizadas por la regla de búsqueda.

minItems: 1maxItems: 20

Lista:minLength: 1maxLength: 255

Ejemplo: ["example"]

product_idsLista <Cadena de texto> Opcional

Identificadores de los productos relacionados.

maxItems: 100

Lista:minLength: 1maxLength: 63

Ejemplo: ["example"]

Campos adicionales: No

Obtener · Reglas — Análisis y reglas de búsqueda — Respuesta

RuleDetailData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

category_idsLista <Cadena de texto> Obligatorio

Identificadores de las categorías relacionadas.

Ejemplo: ["example"]

created_atCadena de textoObligatorio

Momento de creación.

format: "date-time"

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

enabledBooleanoObligatorio

Indica si esta opción está habilitada.

Ejemplo: true

idCadena de textoObligatorio

Identificador del recurso; consérvalo tal como se devuelve. (RuleDetailData).

Ejemplo: "example"

is_availableBooleanoObligatorio

Indica si el elemento está disponible en este contexto.

Ejemplo: true

market_idsLista <Cadena de texto> Obligatorio

Identificadores de los mercados seleccionados.

Ejemplo: ["example"]

market_scopeCadena de textoObligatorio

Indica si el recurso se aplica a todos los mercados o solo a los seleccionados.

Restricciones

enum: ["all", "selected"]

Ejemplo: "all"

nameCadena de textoObligatorio

Nombre del recurso en el contexto correspondiente.

Ejemplo: "Example"

phrase_groupsLista <RulePhraseGroupData > Obligatorio

Grupos de frases de las reglas de búsqueda.

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

product_idsLista <Cadena de texto> Obligatorio

Identificadores de los productos relacionados.

Ejemplo: ["example"]

updated_atCadena de textoObligatorio

Momento de la última actualización.

format: "date-time"

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

versionNúmero enteroObligatorio

Versión del recurso utilizada para controlar cambios simultáneos.

Ejemplo: 1

Campos adicionales: No

Grupos de frases de las reglas de búsqueda

RulePhraseGroupData · Esquema · Esquemas de datos: Análisis y reglas de búsqueda

localeCadena de textoObligatorio: Idioma seleccionado para esta solicitud.

Ejemplo: "en"
phrasesLista <Cadena de texto> Obligatorio: Frases utilizadas por la regla de búsqueda.

Ejemplo: ["example"]

Campos adicionales: No

Listar · Reglas — Análisis y reglas de búsqueda — Respuesta

RuleSummaryData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

created_atCadena de textoObligatorio

Momento de creación.

format: "date-time"

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

enabledBooleanoObligatorio

Indica si esta opción está habilitada.

Ejemplo: true

idCadena de textoObligatorio

Identificador del recurso; consérvalo tal como se devuelve. (RuleSummaryData).

Ejemplo: "example"

is_availableBooleanoObligatorio

Indica si el elemento está disponible en este contexto.

Ejemplo: true

market_scopeCadena de textoObligatorio

Indica si el recurso se aplica a todos los mercados o solo a los seleccionados.

Restricciones

enum: ["all", "selected"]

Ejemplo: "all"

nameCadena de textoObligatorio

Nombre del recurso en el contexto correspondiente.

Ejemplo: "Example"

updated_atCadena de textoObligatorio

Momento de la última actualización.

format: "date-time"

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

versionNúmero enteroObligatorio

Versión del recurso utilizada para controlar cambios simultáneos.

Ejemplo: 1

Campos adicionales: No

Actualizar · Reglas — Análisis y reglas de búsqueda — Cuerpo de la solicitud

RuleUpdate · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

category_idsLista <Cadena de texto> Opcional

Identificadores de las categorías relacionadas.

maxItems: 100

Lista:minLength: 1maxLength: 63

enabledBooleanoOpcional

Indica si esta opción está habilitada.

expected_versionNúmero enteroObligatorio

Versión leída antes de escribir; si no coincide, se rechaza la actualización.

minimum: 1maximum: 2147483647

Ejemplo: 1

market_idsLista <Cadena de texto> Opcional

Identificadores de los mercados seleccionados.

maxItems: 1000

Lista:minLength: 1maxLength: 63

market_scopeCadena de textoOpcional

Indica si el recurso se aplica a todos los mercados o solo a los seleccionados.

Restricciones

enum: ["all", "selected"]

nameCadena de textoOpcional

Nombre del recurso en el contexto correspondiente.

minLength: 1maxLength: 160

Ejemplo: "Example"

phrasesLista <Cadena de texto> Opcional

Frases utilizadas por la regla de búsqueda.

maxItems: 20

Lista:minLength: 1maxLength: 255

product_idsLista <Cadena de texto> Opcional

Identificadores de los productos relacionados.

maxItems: 100

Lista:minLength: 1maxLength: 63

Campos adicionales: No

Filtro de búsquedas con o sin apariciones que no devolvieron resultados

ZeroResultScope · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

Cadena de texto

Restricciones

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

Campos adicionales: Sí