Scheme de date: Analize și reguli de căutare

periodAnalyticsPeriodData Obligatoriu

Perioada de raportare și limitele acesteia.

Exemplu: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}

request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

minLength: 1maxLength: 100

Exemplu: "example"

Câmpuri suplimentare: Nu

as_ofȘir de caractereObligatoriu

Momentul la care se referă datele raportate.

format: "date-time"

Exemplu: "2026-01-02T00:00:00Z"

daysNumăr întregObligatoriu

Perioada de raportare în zile.

Exemplu: 1

started_atȘir de caractereObligatoriu

Data și ora începerii.

format: "date-time"

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

Câmpuri suplimentare: Nu

dataTablou <MetricData > Obligatoriu

Exemplu de răspuns · AnalyticsResponse_list_MetricData__.

Exemplu: [{"clicks":1,"last_seen_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","searches":1,"zero_results":1}]

metaAnalyticsPageMeta | AnalyticsMeta Obligatoriu

Metadatele răspunsului.

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

Câmpuri suplimentare: Nu

dataTablou <OccurrenceData > Obligatoriu

Exemplu de răspuns · AnalyticsResponse_list_OccurrenceData__.

Exemplu: [{"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 Obligatoriu

Metadatele răspunsului.

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

Câmpuri suplimentare: Nu

dataOverviewData Obligatoriu

Exemplu de răspuns · OverviewData.

Exemplu: {"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 Obligatoriu

Metadatele răspunsului.

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

Câmpuri suplimentare: Nu

dataTablou <RuleSummaryData > Obligatoriu

Exemplu de răspuns · ApiResponse_list_RuleSummaryData__.

Exemplu: [{"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 Obligatoriu

Metadatele răspunsului.

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

Câmpuri suplimentare: Nu

dataRuleDetailData Obligatoriu

Exemplu de răspuns · RuleDetailData.

Exemplu: {"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 Obligatoriu

Metadatele răspunsului.

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

Câmpuri suplimentare: Nu

clicksNumăr întregObligatoriu

Numărul de clicuri.

Exemplu: 1

last_seen_atȘir de caractereObligatoriu

Momentul celei mai recente apariții.

format: "date-time"

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

query_displayȘir de caractereObligatoriu

Expresia de căutare afișată administratorului.

Exemplu: "example"

query_hashȘir de caractereObligatoriu

Identificatorul stabil al expresiei de căutare grupate.

Exemplu: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

searchesNumăr întregObligatoriu

Numărul căutărilor.

Exemplu: 1

zero_resultsNumăr întregObligatoriu

Numărul căutărilor fără rezultate.

Exemplu: 1

Câmpuri suplimentare: Nu

category_idȘir de caractere | nullObligatoriu

Identificatorul categoriei.

Exemplu: "example"

category_result_countNumăr întregObligatoriu

Numărul rezultatelor de tip categorie.

Exemplu: 1

currency_codeȘir de caractereObligatoriu

Codul monedei.

Exemplu: "PLN"

is_zero_resultsValoare booleanăObligatoriu

Indică dacă acea căutare nu a returnat rezultate.

Exemplu: false

locale_codeȘir de caractereObligatoriu

Codul limbii.

Exemplu: "en"

market_idȘir de caractereObligatoriu

Identificatorul pieței returnat de endpointul de context.

Exemplu: "example"

max_priceȘir de caractere | nullObligatoriu

Prețul maxim din intervalul raportat.

Exemplu: "0.00"

min_priceȘir de caractere | nullObligatoriu

Prețul minim din intervalul raportat.

Exemplu: "0.00"

occurred_atȘir de caractereObligatoriu

Data și ora evenimentului.

format: "date-time"

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

pageNumăr întregObligatoriu

Informații despre pagina CMS.

Exemplu: 1

product_result_countNumăr întregObligatoriu

Numărul rezultatelor de căutare de tip produs.

Exemplu: 1

query_displayȘir de caractereObligatoriu

Expresia de căutare afișată administratorului.

Exemplu: "example"

request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

Exemplu: "example"

resultsTablou <ResultSnapshotData > | nullObligatoriu

Rezultatele de căutare înregistrate.

Exemplu: [{"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Șir de caractereObligatoriu

Cheia de ordonare.

Exemplu: "example"

sourceȘir de caractereObligatoriu

Sursa activității înregistrate.

Restricții

enum

["results", "autocomplete"]

Exemplu: "results"

Câmpuri suplimentare: Nu

click_through_rateNumărObligatoriu

Rata de clic pentru datele de căutare selectate.

Exemplu: 0

clicked_searchesNumăr întregObligatoriu

Numărul căutărilor care au generat un clic.

Exemplu: 1

recentTablou <RecentSearchData > Obligatoriu

Informații despre căutările recente.

Exemplu: [{"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"}]

searchesNumăr întregObligatoriu

Numărul căutărilor.

Exemplu: 1

zero_result_rateNumărObligatoriu

Proporția căutărilor care nu au returnat rezultate.

Exemplu: 0

zero_resultsNumăr întregObligatoriu

Numărul căutărilor fără rezultate.

Exemplu: 1

Câmpuri suplimentare: Nu

Câmpuri suplimentare: Da

is_zero_resultsValoare booleanăObligatoriu

Indică dacă acea căutare nu a returnat rezultate.

Exemplu: false

locale_codeȘir de caractereObligatoriu

Codul limbii.

Exemplu: "en"

occurred_atȘir de caractereObligatoriu

Data și ora evenimentului.

format: "date-time"

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

query_displayȘir de caractereObligatoriu

Expresia de căutare afișată administratorului.

Exemplu: "example"

query_hashȘir de caractereObligatoriu

Identificatorul stabil al expresiei de căutare grupate.

Exemplu: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

Exemplu: "example"

result_countNumăr întregObligatoriu

Numărul rezultatelor căutării.

Exemplu: 1

sourceȘir de caractereObligatoriu

Sursa activității înregistrate.

Restricții

enum

["results", "autocomplete"]

Exemplu: "results"

Câmpuri suplimentare: Nu

clickedValoare booleanăObligatoriu

Indică dacă s-a făcut clic pe rezultat.

Exemplu: false

entity_idȘir de caractereObligatoriu

Identificatorul entității referite.

Exemplu: "example"

entity_typeȘir de caractereObligatoriu

Tipul entității referite.

Restricții

enum

["product", "category"]

Exemplu: "product"

image_urlȘir de caractere | nullObligatoriu

URL-ul imaginii.

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

numberȘir de caractere | nullObligatoriu

Numărul comenzii sau al solicitării, destinat utilizatorilor.

Exemplu: "example"

placement_sourceȘir de caractereObligatoriu

Sursa din care a fost plasată comanda.

Restricții

enum

["organic", "merchandising"]

Exemplu: "organic"

positionNumăr întregObligatoriu

Poziția în colecția ordonată.

Exemplu: 1

skuȘir de caractereObligatoriu

Codul unității de stoc.

Exemplu: "example"

slugȘir de caractereObligatoriu

Segmentul căii URL în limba selectată.

Exemplu: "example"

titleȘir de caractereObligatoriu

Titlul în limba selectată.

Exemplu: "example"

Câmpuri suplimentare: Nu

category_idsTablou <Șir de caractere> Opțional

Identificatorii categoriilor asociate.

maxItems: 100

Tablou:minLength: 1maxLength: 63

enabledValoare booleanăOpțional

Indică dacă această setare este activată.

Valoare implicită: false

market_idsTablou <Șir de caractere> Opțional

Identificatorii piețelor selectate.

maxItems: 1000

Tablou:minLength: 1maxLength: 63

market_scopeȘir de caractereOpțional

Indică dacă resursa se aplică tuturor piețelor sau numai celor selectate.

Restricții

enum

["all", "selected"]

nameȘir de caractereObligatoriu

Numele resursei în contextul relevant.

minLength: 1maxLength: 160

Exemplu: "Example"

phrasesTablou <Șir de caractere> Obligatoriu

Expresiile folosite de regula de căutare.

minItems: 1maxItems: 20

Tablou:minLength: 1maxLength: 255

Exemplu: ["example"]

product_idsTablou <Șir de caractere> Opțional

Identificatorii produselor asociate.

maxItems: 100

Tablou:minLength: 1maxLength: 63

Exemplu: ["example"]

Câmpuri suplimentare: Nu

category_idsTablou <Șir de caractere> Obligatoriu

Identificatorii categoriilor asociate.

Exemplu: ["example"]

created_atȘir de caractereObligatoriu

Momentul creării.

format: "date-time"

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

enabledValoare booleanăObligatoriu

Indică dacă această setare este activată.

Exemplu: true

idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. (RuleDetailData).

Exemplu: "example"

is_availableValoare booleanăObligatoriu

Indică dacă articolul este disponibil în acest context.

Exemplu: true

market_idsTablou <Șir de caractere> Obligatoriu

Identificatorii piețelor selectate.

Exemplu: ["example"]

market_scopeȘir de caractereObligatoriu

Indică dacă resursa se aplică tuturor piețelor sau numai celor selectate.

Restricții

enum

["all", "selected"]

Exemplu: "all"

nameȘir de caractereObligatoriu

Numele resursei în contextul relevant.

Exemplu: "Example"

phrase_groupsTablou <RulePhraseGroupData > Obligatoriu

Grupuri de expresii ale regulii de căutare.

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

product_idsTablou <Șir de caractere> Obligatoriu

Identificatorii produselor asociate.

Exemplu: ["example"]

updated_atȘir de caractereObligatoriu

Momentul celei mai recente actualizări.

format: "date-time"

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

versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 1

Câmpuri suplimentare: Nu

localeȘir de caractereObligatoriu

Limba selectată pentru această cerere.

Exemplu: "en"

phrasesTablou <Șir de caractere> Obligatoriu

Expresiile folosite de regula de căutare.

Exemplu: ["example"]

Câmpuri suplimentare: Nu

created_atȘir de caractereObligatoriu

Momentul creării.

format: "date-time"

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

enabledValoare booleanăObligatoriu

Indică dacă această setare este activată.

Exemplu: true

idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. (RuleSummaryData).

Exemplu: "example"

is_availableValoare booleanăObligatoriu

Indică dacă articolul este disponibil în acest context.

Exemplu: true

market_scopeȘir de caractereObligatoriu

Indică dacă resursa se aplică tuturor piețelor sau numai celor selectate.

Restricții

enum

["all", "selected"]

Exemplu: "all"

nameȘir de caractereObligatoriu

Numele resursei în contextul relevant.

Exemplu: "Example"

updated_atȘir de caractereObligatoriu

Momentul celei mai recente actualizări.

format: "date-time"

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

versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 1

Câmpuri suplimentare: Nu

category_idsTablou <Șir de caractere> Opțional

Identificatorii categoriilor asociate.

maxItems: 100

Tablou:minLength: 1maxLength: 63

enabledValoare booleanăOpțional

Indică dacă această setare este activată.

expected_versionNumăr întregObligatoriu

Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1maximum: 2147483647

Exemplu: 1

market_idsTablou <Șir de caractere> Opțional

Identificatorii piețelor selectate.

maxItems: 1000

Tablou:minLength: 1maxLength: 63

market_scopeȘir de caractereOpțional

Indică dacă resursa se aplică tuturor piețelor sau numai celor selectate.

Restricții

enum

["all", "selected"]

nameȘir de caractereOpțional

Numele resursei în contextul relevant.

minLength: 1maxLength: 160

Exemplu: "Example"

phrasesTablou <Șir de caractere> Opțional

Expresiile folosite de regula de căutare.

maxItems: 20

Tablou:minLength: 1maxLength: 255

product_idsTablou <Șir de caractere> Opțional

Identificatorii produselor asociate.

maxItems: 100

Tablou:minLength: 1maxLength: 63

Câmpuri suplimentare: Nu

Câmpuri suplimentare: Da