Dátové schémy: Analytika a pravidlá vyhľadávania

Dátové schémy: Analytika a pravidlá vyhľadávania. Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

Dátové schémy

Metaúdaje odpovede

AnalyticsMeta · Schéma · Dátové schémy: Analytika a pravidlá vyhľadávania

periodAnalyticsPeriodData Povinné: Obdobie prehľadu a jeho hranice.

Príklad: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idReťazecPovinné: Identifikátor požiadavky; v metaúdajoch odpovede označuje požiadavku HTTP.

minLength: 1maxLength: 100

Príklad: "example"

Ďalšie polia: Nie

Obdobie prehľadu a jeho hranice

AnalyticsPeriodData · Schéma · Dátové schémy: Analytika a pravidlá vyhľadávania

as_ofReťazecPovinné: Čas, ku ktorému sa vzťahujú vykázané údaje.

format: "date-time"

Príklad: "2026-01-02T00:00:00Z"
daysCelé čísloPovinné: Obdobie prehľadu v dňoch.

Príklad: 1
started_atReťazecPovinné: Dátum a čas začatia.

format: "date-time"

Príklad: "2026-01-01T00:00:00Z"

Ďalšie polia: Nie

Zobraziť zoznam · Vyhľadávacie dopyty — Analytika a pravidlá vyhľadávania — Odpoveď

AnalyticsResponse_list_MetricData__ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

dataPole <MetricData > Povinné: Príklad odpovede · AnalyticsResponse_list_MetricData__.

Príklad: [{"clicks":1,"last_seen_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","searches":1,"zero_results":1}]
metaAnalyticsPageMeta AnalyticsMeta Povinné: Metaúdaje odpovede.

Príklad: {"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"}

Ďalšie polia: Nie

Načítať · Vyhľadávacie dopyty — Analytika a pravidlá vyhľadávania — Odpoveď

AnalyticsResponse_list_OccurrenceData__ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

dataPole <OccurrenceData > Povinné: Príklad odpovede · AnalyticsResponse_list_OccurrenceData__.

Príklad: [{"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 Povinné: Metaúdaje odpovede.

Príklad: {"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"}

Ďalšie polia: Nie

Súhrn — Analytika a pravidlá vyhľadávania — Odpoveď

AnalyticsResponse_OverviewData_ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

dataOverviewData Povinné: Príklad odpovede · OverviewData.

Príklad: {"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 Povinné: Metaúdaje odpovede.

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

Ďalšie polia: Nie

Zobraziť zoznam · Pravidlá — Analytika a pravidlá vyhľadávania — Odpoveď

ApiResponse_list_RuleSummaryData__ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

dataPole <RuleSummaryData > Povinné: Príklad odpovede · ApiResponse_list_RuleSummaryData__.

Príklad: [{"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 Povinné: Metaúdaje odpovede.

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

Ďalšie polia: Nie

Načítať · Pravidlá — Analytika a pravidlá vyhľadávania — Odpoveď

ApiResponse_RuleDetailData_ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

dataRuleDetailData Povinné: Príklad odpovede · RuleDetailData.

Príklad: {"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 Povinné: Metaúdaje odpovede.

Príklad: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Ďalšie polia: Nie

Zobraziť zoznam · Vyhľadávacie dopyty — Analytika a pravidlá vyhľadávania — Odpoveď

MetricData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

clicksCelé čísloPovinné: Počet kliknutí.

Príklad: 1
last_seen_atReťazecPovinné: Čas posledného výskytu.

format: "date-time"

Príklad: "2026-01-01T12:00:00Z"
query_displayReťazecPovinné: Vyhľadávacia fráza zobrazená správcovi.

Príklad: "example"
query_hashReťazecPovinné: Stabilný identifikátor zoskupenej vyhľadávacej frázy.

Príklad: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
searchesCelé čísloPovinné: Počet vyhľadávaní.

Príklad: 1
zero_resultsCelé čísloPovinné: Počet vyhľadávaní bez výsledkov.

Príklad: 1

Ďalšie polia: Nie

Načítať · Vyhľadávacie dopyty — Analytika a pravidlá vyhľadávania — Odpoveď

OccurrenceData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

category_idReťazec nullPovinné

Identifikátor kategórie.

Príklad: "example"

category_result_countCelé čísloPovinné

Počet výsledkov v kategóriách.

Príklad: 1

currency_codeReťazecPovinné

Kód meny.

Príklad: "PLN"

is_zero_resultsLogická hodnotaPovinné

Či vyhľadávanie nevrátilo žiadne výsledky.

Príklad: false

locale_codeReťazecPovinné

Kód jazyka.

Príklad: "en"

market_idReťazecPovinné

Identifikátor trhu vrátený koncovým bodom kontextu.

Príklad: "example"

max_priceReťazec nullPovinné

Najvyššia cena vo vykázanom rozmedzí.

Príklad: "0.00"

min_priceReťazec nullPovinné

Najnižšia cena vo vykázanom rozmedzí.

Príklad: "0.00"

occurred_atReťazecPovinné

Dátum a čas udalosti.

format: "date-time"

Príklad: "2026-01-01T12:00:00Z"

pageCelé čísloPovinné

Informácie o stránke CMS.

Príklad: 1

product_result_countCelé čísloPovinné

Počet výsledkov vyhľadávania produktov.

Príklad: 1

query_displayReťazecPovinné

Vyhľadávacia fráza zobrazená správcovi.

Príklad: "example"

request_idReťazecPovinné

Identifikátor požiadavky; v metaúdajoch odpovede označuje požiadavku HTTP.

Príklad: "example"

resultsPole <ResultSnapshotData > nullPovinné

Zaznamenané výsledky vyhľadávania.

Príklad:

[{"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_keyReťazecPovinné

Kľúč zoradenia.

Príklad: "example"

sourceReťazecPovinné

Zdroj zaznamenanej aktivity.

Obmedzenia

enum: ["results", "autocomplete"]

Príklad: "results"

Ďalšie polia: Nie

Súhrn — Analytika a pravidlá vyhľadávania — Odpoveď

OverviewData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

click_through_rateČísloPovinné: Miera preklikov pre vybrané údaje vyhľadávania.

Príklad: 0
clicked_searchesCelé čísloPovinné: Počet vyhľadávaní s kliknutím.

Príklad: 1
recentPole <RecentSearchData > Povinné: Informácie o nedávnych vyhľadávaniach.

Príklad: [{"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"}]
searchesCelé čísloPovinné: Počet vyhľadávaní.

Príklad: 1
zero_result_rateČísloPovinné: Podiel vyhľadávaní bez výsledkov.

Príklad: 0
zero_resultsCelé čísloPovinné: Počet vyhľadávaní bez výsledkov.

Príklad: 1

Ďalšie polia: Nie

Zoradenie vybrané pre výsledky

QueryMetricSort · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

Reťazec

Obmedzenia

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

Ďalšie polia: Áno

Informácie o nedávnych vyhľadávaniach

RecentSearchData · Schéma · Dátové schémy: Analytika a pravidlá vyhľadávania

is_zero_resultsLogická hodnotaPovinné

Či vyhľadávanie nevrátilo žiadne výsledky.

Príklad: false

locale_codeReťazecPovinné

Kód jazyka.

Príklad: "en"

occurred_atReťazecPovinné

Dátum a čas udalosti.

format: "date-time"

Príklad: "2026-01-01T12:00:00Z"

query_displayReťazecPovinné

Vyhľadávacia fráza zobrazená správcovi.

Príklad: "example"

query_hashReťazecPovinné

Stabilný identifikátor zoskupenej vyhľadávacej frázy.

Príklad: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idReťazecPovinné

Identifikátor požiadavky; v metaúdajoch odpovede označuje požiadavku HTTP.

Príklad: "example"

result_countCelé čísloPovinné

Počet výsledkov vyhľadávania.

Príklad: 1

sourceReťazecPovinné

Zdroj zaznamenanej aktivity.

Obmedzenia

enum: ["results", "autocomplete"]

Príklad: "results"

Ďalšie polia: Nie

Zaznamenané výsledky vyhľadávania

ResultSnapshotData · Schéma · Dátové schémy: Analytika a pravidlá vyhľadávania

clickedLogická hodnotaPovinné

Či sa na výsledok kliklo.

Príklad: false

entity_idReťazecPovinné

Identifikátor odkazovanej entity.

Príklad: "example"

entity_typeReťazecPovinné

Typ odkazovanej entity.

Obmedzenia

enum: ["product", "category"]

Príklad: "product"

image_urlReťazec nullPovinné

URL obrázka.

Príklad: "https://example.invalid/product.jpg"

numberReťazec nullPovinné

Číslo objednávky alebo zákazníckej žiadosti určené pre používateľa.

Príklad: "example"

placement_sourceReťazecPovinné

Zdroj vytvorenia objednávky.

Obmedzenia

enum: ["organic", "merchandising"]

Príklad: "organic"

positionCelé čísloPovinné

Pozícia v zoradenom zozname.

Príklad: 1

skuReťazecPovinné

Skladový kód položky.

Príklad: "example"

slugReťazecPovinné

Úsek cesty URL vo vybranom jazyku.

Príklad: "example"

titleReťazecPovinné

Názov vo vybranom jazyku.

Príklad: "example"

Ďalšie polia: Nie

Vytvoriť · Pravidlá — Analytika a pravidlá vyhľadávania — Telo požiadavky

RuleCreate · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

category_idsPole <Reťazec> Voliteľné

Identifikátory súvisiacich kategórií.

maxItems: 100

Pole:minLength: 1maxLength: 63

enabledLogická hodnotaVoliteľné

Či je nastavenie zapnuté.

Predvolená hodnota: false

market_idsPole <Reťazec> Voliteľné

Identifikátory vybraných trhov.

maxItems: 1000

Pole:minLength: 1maxLength: 63

market_scopeReťazecVoliteľné

Či zdroj platí pre všetky alebo len vybrané trhy.

Obmedzenia

enum: ["all", "selected"]

nameReťazecPovinné

Názov zdroja v príslušnom kontexte.

minLength: 1maxLength: 160

Príklad: "Example"

phrasesPole <Reťazec> Povinné

Frázy používané pravidlom vyhľadávania.

minItems: 1maxItems: 20

Pole:minLength: 1maxLength: 255

Príklad: ["example"]

product_idsPole <Reťazec> Voliteľné

Identifikátory súvisiacich produktov.

maxItems: 100

Pole:minLength: 1maxLength: 63

Príklad: ["example"]

Ďalšie polia: Nie

Načítať · Pravidlá — Analytika a pravidlá vyhľadávania — Odpoveď

RuleDetailData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

category_idsPole <Reťazec> Povinné

Identifikátory súvisiacich kategórií.

Príklad: ["example"]

created_atReťazecPovinné

Čas vytvorenia.

format: "date-time"

Príklad: "2026-01-01T12:00:00Z"

enabledLogická hodnotaPovinné

Či je nastavenie zapnuté.

Príklad: true

idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (RuleDetailData).

Príklad: "example"

is_availableLogická hodnotaPovinné

Či je položka v tomto kontexte dostupná.

Príklad: true

market_idsPole <Reťazec> Povinné

Identifikátory vybraných trhov.

Príklad: ["example"]

market_scopeReťazecPovinné

Či zdroj platí pre všetky alebo len vybrané trhy.

Obmedzenia

enum: ["all", "selected"]

Príklad: "all"

nameReťazecPovinné

Názov zdroja v príslušnom kontexte.

Príklad: "Example"

phrase_groupsPole <RulePhraseGroupData > Povinné

Skupiny fráz pravidla vyhľadávania.

Príklad: [{"locale":"en","phrases":["example"]}]

product_idsPole <Reťazec> Povinné

Identifikátory súvisiacich produktov.

Príklad: ["example"]

updated_atReťazecPovinné

Čas poslednej aktualizácie.

format: "date-time"

Príklad: "2026-01-01T12:00:00Z"

versionCelé čísloPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 1

Ďalšie polia: Nie

Skupiny fráz pravidla vyhľadávania

RulePhraseGroupData · Schéma · Dátové schémy: Analytika a pravidlá vyhľadávania

localeReťazecPovinné: Jazyk vybraný pre túto požiadavku.

Príklad: "en"
phrasesPole <Reťazec> Povinné: Frázy používané pravidlom vyhľadávania.

Príklad: ["example"]

Ďalšie polia: Nie

Zobraziť zoznam · Pravidlá — Analytika a pravidlá vyhľadávania — Odpoveď

RuleSummaryData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

created_atReťazecPovinné

Čas vytvorenia.

format: "date-time"

Príklad: "2026-01-01T12:00:00Z"

enabledLogická hodnotaPovinné

Či je nastavenie zapnuté.

Príklad: true

idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (RuleSummaryData).

Príklad: "example"

is_availableLogická hodnotaPovinné

Či je položka v tomto kontexte dostupná.

Príklad: true

market_scopeReťazecPovinné

Či zdroj platí pre všetky alebo len vybrané trhy.

Obmedzenia

enum: ["all", "selected"]

Príklad: "all"

nameReťazecPovinné

Názov zdroja v príslušnom kontexte.

Príklad: "Example"

updated_atReťazecPovinné

Čas poslednej aktualizácie.

format: "date-time"

Príklad: "2026-01-01T12:00:00Z"

versionCelé čísloPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 1

Ďalšie polia: Nie

Upraviť · Pravidlá — Analytika a pravidlá vyhľadávania — Telo požiadavky

RuleUpdate · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

category_idsPole <Reťazec> Voliteľné

Identifikátory súvisiacich kategórií.

maxItems: 100

Pole:minLength: 1maxLength: 63

enabledLogická hodnotaVoliteľné

Či je nastavenie zapnuté.

expected_versionCelé čísloPovinné

Verzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.

minimum: 1maximum: 2147483647

Príklad: 1

market_idsPole <Reťazec> Voliteľné

Identifikátory vybraných trhov.

maxItems: 1000

Pole:minLength: 1maxLength: 63

market_scopeReťazecVoliteľné

Či zdroj platí pre všetky alebo len vybrané trhy.

Obmedzenia

enum: ["all", "selected"]

nameReťazecVoliteľné

Názov zdroja v príslušnom kontexte.

minLength: 1maxLength: 160

Príklad: "Example"

phrasesPole <Reťazec> Voliteľné

Frázy používané pravidlom vyhľadávania.

maxItems: 20

Pole:minLength: 1maxLength: 255

product_idsPole <Reťazec> Voliteľné

Identifikátory súvisiacich produktov.

maxItems: 100

Pole:minLength: 1maxLength: 63

Ďalšie polia: Nie

Filter vyberajúci vyhľadávania s výskytmi bez výsledkov alebo bez takýchto výskytov

ZeroResultScope · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

Reťazec

Obmedzenia

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

Ďalšie polia: Áno