Schemi dei dati: Analisi e regole di ricerca

Schemi dei dati: Analisi e regole di ricerca. Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

Schemi dei dati

Metadati della risposta

AnalyticsMeta · Schema · Schemi dei dati: Analisi e regole di ricerca

periodAnalyticsPeriodData Obbligatorio: Periodo di rendicontazione e relativi limiti temporali.

Esempio: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idStringaObbligatorio: Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

minLength: 1maxLength: 100

Esempio: "example"

Campi aggiuntivi: No

Periodo di rendicontazione e relativi limiti temporali

AnalyticsPeriodData · Schema · Schemi dei dati: Analisi e regole di ricerca

as_ofStringaObbligatorio: Istante a cui si riferiscono i dati riportati.

format: "date-time"

Esempio: "2026-01-02T00:00:00Z"
daysInteroObbligatorio: Periodo di rendicontazione in giorni.

Esempio: 1
started_atStringaObbligatorio: Data e ora di inizio.

format: "date-time"

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

Campi aggiuntivi: No

Elenca · Ricerche — Analisi e regole di ricerca — Risposta

AnalyticsResponse_list_MetricData__ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

dataArray <MetricData > Obbligatorio: Esempio di risposta · AnalyticsResponse_list_MetricData__.

Esempio: [{"clicks":1,"last_seen_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","searches":1,"zero_results":1}]
metaAnalyticsPageMeta AnalyticsMeta Obbligatorio: Metadati della risposta.

Esempio: {"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"}

Campi aggiuntivi: No

Recupera · Ricerche — Analisi e regole di ricerca — Risposta

AnalyticsResponse_list_OccurrenceData__ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

dataArray <OccurrenceData > Obbligatorio: Esempio di risposta · AnalyticsResponse_list_OccurrenceData__.

Esempio: [{"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 Obbligatorio: Metadati della risposta.

Esempio: {"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"}

Campi aggiuntivi: No

Riepilogo — Analisi e regole di ricerca — Risposta

AnalyticsResponse_OverviewData_ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

dataOverviewData Obbligatorio: Esempio di risposta · OverviewData.

Esempio: {"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 Obbligatorio: Metadati della risposta.

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

Campi aggiuntivi: No

Elenca · Regole — Analisi e regole di ricerca — Risposta

ApiResponse_list_RuleSummaryData__ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

dataArray <RuleSummaryData > Obbligatorio: Esempio di risposta · ApiResponse_list_RuleSummaryData__.

Esempio: [{"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 Obbligatorio: Metadati della risposta.

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

Campi aggiuntivi: No

Recupera · Regole — Analisi e regole di ricerca — Risposta

ApiResponse_RuleDetailData_ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

dataRuleDetailData Obbligatorio: Esempio di risposta · RuleDetailData.

Esempio: {"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 Obbligatorio: Metadati della risposta.

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

Campi aggiuntivi: No

Elenca · Ricerche — Analisi e regole di ricerca — Risposta

MetricData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

clicksInteroObbligatorio: Numero di clic.

Esempio: 1
last_seen_atStringaObbligatorio: Data e ora dell’occorrenza più recente.

format: "date-time"

Esempio: "2026-01-01T12:00:00Z"
query_displayStringaObbligatorio: Frase di ricerca mostrata all’amministratore.

Esempio: "example"
query_hashStringaObbligatorio: Identificativo stabile della frase di ricerca raggruppata.

Esempio: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
searchesInteroObbligatorio: Numero di ricerche.

Esempio: 1
zero_resultsInteroObbligatorio: Numero di ricerche senza risultati.

Esempio: 1

Campi aggiuntivi: No

Recupera · Ricerche — Analisi e regole di ricerca — Risposta

OccurrenceData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

category_idStringa nullObbligatorio

Identificativo della categoria.

Esempio: "example"

category_result_countInteroObbligatorio

Numero di risultati relativi alle categorie.

Esempio: 1

currency_codeStringaObbligatorio

Codice della valuta.

Esempio: "PLN"

is_zero_resultsBooleanoObbligatorio

Indica se la ricerca non ha prodotto risultati.

Esempio: false

locale_codeStringaObbligatorio

Codice della lingua.

Esempio: "en"

market_idStringaObbligatorio

Identificativo del mercato restituito dall’endpoint del contesto.

Esempio: "example"

max_priceStringa nullObbligatorio

Prezzo massimo nell’intervallo riportato.

Esempio: "0.00"

min_priceStringa nullObbligatorio

Prezzo minimo nell’intervallo riportato.

Esempio: "0.00"

occurred_atStringaObbligatorio

Data e ora dell’evento.

format: "date-time"

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

pageInteroObbligatorio

Informazioni sulla pagina CMS.

Esempio: 1

product_result_countInteroObbligatorio

Numero di prodotti nei risultati di ricerca.

Esempio: 1

query_displayStringaObbligatorio

Frase di ricerca mostrata all’amministratore.

Esempio: "example"

request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

Esempio: "example"

resultsArray <ResultSnapshotData > nullObbligatorio

Risultati di ricerca registrati.

Esempio:

[{"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_keyStringaObbligatorio

Chiave di ordinamento.

Esempio: "example"

sourceStringaObbligatorio

Origine dell’attività registrata.

Vincoli

enum: ["results", "autocomplete"]

Esempio: "results"

Campi aggiuntivi: No

Riepilogo — Analisi e regole di ricerca — Risposta

OverviewData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

click_through_rateNumeroObbligatorio: Tasso di clic per i dati di ricerca selezionati.

Esempio: 0
clicked_searchesInteroObbligatorio: Numero di ricerche con un clic.

Esempio: 1
recentArray <RecentSearchData > Obbligatorio: Informazioni sulle ricerche recenti.

Esempio: [{"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"}]
searchesInteroObbligatorio: Numero di ricerche.

Esempio: 1
zero_result_rateNumeroObbligatorio: Percentuale di ricerche che non hanno prodotto risultati.

Esempio: 0
zero_resultsInteroObbligatorio: Numero di ricerche senza risultati.

Esempio: 1

Campi aggiuntivi: No

Ordinamento selezionato per i risultati

QueryMetricSort · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

Stringa

Vincoli

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

Campi aggiuntivi: Sì

Informazioni sulle ricerche recenti

RecentSearchData · Schema · Schemi dei dati: Analisi e regole di ricerca

is_zero_resultsBooleanoObbligatorio

Indica se la ricerca non ha prodotto risultati.

Esempio: false

locale_codeStringaObbligatorio

Codice della lingua.

Esempio: "en"

occurred_atStringaObbligatorio

Data e ora dell’evento.

format: "date-time"

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

query_displayStringaObbligatorio

Frase di ricerca mostrata all’amministratore.

Esempio: "example"

query_hashStringaObbligatorio

Identificativo stabile della frase di ricerca raggruppata.

Esempio: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

Esempio: "example"

result_countInteroObbligatorio

Numero di risultati della ricerca.

Esempio: 1

sourceStringaObbligatorio

Origine dell’attività registrata.

Vincoli

enum: ["results", "autocomplete"]

Esempio: "results"

Campi aggiuntivi: No

Risultati di ricerca registrati

ResultSnapshotData · Schema · Schemi dei dati: Analisi e regole di ricerca

clickedBooleanoObbligatorio

Indica se il risultato ha ricevuto un clic.

Esempio: false

entity_idStringaObbligatorio

Identificativo dell’entità referenziata.

Esempio: "example"

entity_typeStringaObbligatorio

Tipo dell’entità referenziata.

Vincoli

enum: ["product", "category"]

Esempio: "product"

image_urlStringa nullObbligatorio

URL dell’immagine.

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

numberStringa nullObbligatorio

Numero dell’ordine o della richiesta destinato alle persone.

Esempio: "example"

placement_sourceStringaObbligatorio

Origine da cui è stato effettuato l’ordine.

Vincoli

enum: ["organic", "merchandising"]

Esempio: "organic"

positionInteroObbligatorio

Posizione nella collezione ordinata.

Esempio: 1

skuStringaObbligatorio

Codice di identificazione dell’articolo a magazzino.

Esempio: "example"

slugStringaObbligatorio

Segmento del percorso URL nella lingua selezionata.

Esempio: "example"

titleStringaObbligatorio

Titolo nella lingua selezionata.

Esempio: "example"

Campi aggiuntivi: No

Crea · Regole — Analisi e regole di ricerca — Corpo della richiesta

RuleCreate · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

category_idsArray <Stringa> Facoltativo

Identificativi delle categorie collegate.

maxItems: 100

Array:minLength: 1maxLength: 63

enabledBooleanoFacoltativo

Indica se questa impostazione è abilitata.

Valore predefinito: false

market_idsArray <Stringa> Facoltativo

Identificativi dei mercati selezionati.

maxItems: 1000

Array:minLength: 1maxLength: 63

market_scopeStringaFacoltativo

Indica se la risorsa si applica a tutti i mercati o a quelli selezionati.

Vincoli

enum: ["all", "selected"]

nameStringaObbligatorio

Nome della risorsa nel contesto pertinente.

minLength: 1maxLength: 160

Esempio: "Example"

phrasesArray <Stringa> Obbligatorio

Frasi utilizzate dalla regola di ricerca.

minItems: 1maxItems: 20

Array:minLength: 1maxLength: 255

Esempio: ["example"]

product_idsArray <Stringa> Facoltativo

Identificativi dei prodotti collegati.

maxItems: 100

Array:minLength: 1maxLength: 63

Esempio: ["example"]

Campi aggiuntivi: No

Recupera · Regole — Analisi e regole di ricerca — Risposta

RuleDetailData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

category_idsArray <Stringa> Obbligatorio

Identificativi delle categorie collegate.

Esempio: ["example"]

created_atStringaObbligatorio

Data e ora di creazione.

format: "date-time"

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

enabledBooleanoObbligatorio

Indica se questa impostazione è abilitata.

Esempio: true

idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito. (RuleDetailData).

Esempio: "example"

is_availableBooleanoObbligatorio

Indica se l’elemento è disponibile in questo contesto.

Esempio: true

market_idsArray <Stringa> Obbligatorio

Identificativi dei mercati selezionati.

Esempio: ["example"]

market_scopeStringaObbligatorio

Indica se la risorsa si applica a tutti i mercati o a quelli selezionati.

Vincoli

enum: ["all", "selected"]

Esempio: "all"

nameStringaObbligatorio

Nome della risorsa nel contesto pertinente.

Esempio: "Example"

phrase_groupsArray <RulePhraseGroupData > Obbligatorio

Gruppi di frasi delle regole di ricerca.

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

product_idsArray <Stringa> Obbligatorio

Identificativi dei prodotti collegati.

Esempio: ["example"]

updated_atStringaObbligatorio

Data e ora dell’aggiornamento più recente.

format: "date-time"

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

versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 1

Campi aggiuntivi: No

Gruppi di frasi delle regole di ricerca

RulePhraseGroupData · Schema · Schemi dei dati: Analisi e regole di ricerca

localeStringaObbligatorio: Lingua selezionata per questa richiesta.

Esempio: "en"
phrasesArray <Stringa> Obbligatorio: Frasi utilizzate dalla regola di ricerca.

Esempio: ["example"]

Campi aggiuntivi: No

Elenca · Regole — Analisi e regole di ricerca — Risposta

RuleSummaryData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

created_atStringaObbligatorio

Data e ora di creazione.

format: "date-time"

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

enabledBooleanoObbligatorio

Indica se questa impostazione è abilitata.

Esempio: true

idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito. (RuleSummaryData).

Esempio: "example"

is_availableBooleanoObbligatorio

Indica se l’elemento è disponibile in questo contesto.

Esempio: true

market_scopeStringaObbligatorio

Indica se la risorsa si applica a tutti i mercati o a quelli selezionati.

Vincoli

enum: ["all", "selected"]

Esempio: "all"

nameStringaObbligatorio

Nome della risorsa nel contesto pertinente.

Esempio: "Example"

updated_atStringaObbligatorio

Data e ora dell’aggiornamento più recente.

format: "date-time"

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

versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 1

Campi aggiuntivi: No

Aggiorna · Regole — Analisi e regole di ricerca — Corpo della richiesta

RuleUpdate · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

category_idsArray <Stringa> Facoltativo

Identificativi delle categorie collegate.

maxItems: 100

Array:minLength: 1maxLength: 63

enabledBooleanoFacoltativo

Indica se questa impostazione è abilitata.

expected_versionInteroObbligatorio

Versione letta prima della scrittura; una differenza impedisce l’aggiornamento.

minimum: 1maximum: 2147483647

Esempio: 1

market_idsArray <Stringa> Facoltativo

Identificativi dei mercati selezionati.

maxItems: 1000

Array:minLength: 1maxLength: 63

market_scopeStringaFacoltativo

Indica se la risorsa si applica a tutti i mercati o a quelli selezionati.

Vincoli

enum: ["all", "selected"]

nameStringaFacoltativo

Nome della risorsa nel contesto pertinente.

minLength: 1maxLength: 160

Esempio: "Example"

phrasesArray <Stringa> Facoltativo

Frasi utilizzate dalla regola di ricerca.

maxItems: 20

Array:minLength: 1maxLength: 255

product_idsArray <Stringa> Facoltativo

Identificativi dei prodotti collegati.

maxItems: 100

Array:minLength: 1maxLength: 63

Campi aggiuntivi: No

Filtro delle ricerche con o senza occorrenze prive di risultati

ZeroResultScope · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

Stringa

Vincoli

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

Campi aggiuntivi: Sì