Datová schémata: Analytika a pravidla vyhledávání

Datová schémata: Analytika a pravidla vyhledávání. Pole, typy a omezení dat přijímaných nebo vracených API.

Datová schémata

Metadata odpovědi

AnalyticsMeta · Schéma · Datová schémata: Analytika a pravidla vyhledávání

periodAnalyticsPeriodData Povinné: Období přehledu a jeho hranice.

Příklad: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idŘetězecPovinné: Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100

Příklad: "example"

Další pole: Ne

Období přehledu a jeho hranice

AnalyticsPeriodData · Schéma · Datová schémata: Analytika a pravidla vyhledávání

as_ofŘetězecPovinné: Čas, ke kterému se vztahují vykázaná data.

format: "date-time"

Příklad: "2026-01-02T00:00:00Z"
daysCelé čísloPovinné: Období přehledu ve dnech.

Příklad: 1
started_atŘetězecPovinné: Datum a čas zahájení.

format: "date-time"

Příklad: "2026-01-01T00:00:00Z"

Další pole: Ne

Vypsat · Vyhledávací dotazy — Analytika a pravidla vyhledávání — Odpověď

AnalyticsResponse_list_MetricData__ · Pole, typy a omezení dat přijímaných nebo vracených API.

dataPole <MetricData > Povinné: Příklad odpovědi · AnalyticsResponse_list_MetricData__.

Pří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é: Metadata odpovědi.

Pří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"}

Další pole: Ne

Načíst · Vyhledávací dotazy — Analytika a pravidla vyhledávání — Odpověď

AnalyticsResponse_list_OccurrenceData__ · Pole, typy a omezení dat přijímaných nebo vracených API.

dataPole <OccurrenceData > Povinné: Příklad odpovědi · AnalyticsResponse_list_OccurrenceData__.

Pří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é: Metadata odpovědi.

Pří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"}

Další pole: Ne

Souhrn — Analytika a pravidla vyhledávání — Odpověď

AnalyticsResponse_OverviewData_ · Pole, typy a omezení dat přijímaných nebo vracených API.

dataOverviewData Povinné: Příklad odpovědi · OverviewData.

Pří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é: Metadata odpovědi.

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

Další pole: Ne

Vypsat · Pravidla — Analytika a pravidla vyhledávání — Odpověď

ApiResponse_list_RuleSummaryData__ · Pole, typy a omezení dat přijímaných nebo vracených API.

dataPole <RuleSummaryData > Povinné: Příklad odpovědi · ApiResponse_list_RuleSummaryData__.

Pří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é: Metadata odpovědi.

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

Další pole: Ne

Načíst · Pravidla — Analytika a pravidla vyhledávání — Odpověď

ApiResponse_RuleDetailData_ · Pole, typy a omezení dat přijímaných nebo vracených API.

dataRuleDetailData Povinné: Příklad odpovědi · RuleDetailData.

Pří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é: Metadata odpovědi.

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

Další pole: Ne

Vypsat · Vyhledávací dotazy — Analytika a pravidla vyhledávání — Odpověď

MetricData · Pole, typy a omezení dat přijímaných nebo vracených API.

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

Příklad: 1
last_seen_atŘetězecPovinné: Čas posledního výskytu.

format: "date-time"

Příklad: "2026-01-01T12:00:00Z"
query_displayŘetězecPovinné: Vyhledávací fráze zobrazená správci.

Příklad: "example"
query_hashŘetězecPovinné: Stabilní identifikátor seskupené vyhledávací fráze.

Příklad: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
searchesCelé čísloPovinné: Počet vyhledávání.

Příklad: 1
zero_resultsCelé čísloPovinné: Počet vyhledávání bez výsledků.

Příklad: 1

Další pole: Ne

Načíst · Vyhledávací dotazy — Analytika a pravidla vyhledávání — Odpověď

OccurrenceData · Pole, typy a omezení dat přijímaných nebo vracených API.

category_idŘetězec nullPovinné

Identifikátor kategorie.

Příklad: "example"

category_result_countCelé čísloPovinné

Počet výsledků v kategoriích.

Příklad: 1

currency_codeŘetězecPovinné

Kód měny.

Příklad: "PLN"

is_zero_resultsLogická hodnotaPovinné

Zda vyhledávání nevrátilo žádné výsledky.

Příklad: false

locale_codeŘetězecPovinné

Kód jazyka.

Příklad: "en"

market_idŘetězecPovinné

Identifikátor trhu vrácený koncovým bodem kontextu.

Příklad: "example"

max_priceŘetězec nullPovinné

Nejvyšší cena ve vykázaném rozmezí.

Příklad: "0.00"

min_priceŘetězec nullPovinné

Nejnižší cena ve vykázaném rozmezí.

Příklad: "0.00"

occurred_atŘetězecPovinné

Datum a čas události.

format: "date-time"

Příklad: "2026-01-01T12:00:00Z"

pageCelé čísloPovinné

Informace o stránce CMS.

Příklad: 1

product_result_countCelé čísloPovinné

Počet výsledků vyhledávání produktů.

Příklad: 1

query_displayŘetězecPovinné

Vyhledávací fráze zobrazená správci.

Příklad: "example"

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

Příklad: "example"

resultsPole <ResultSnapshotData > nullPovinné

Zaznamenané výsledky vyhledávání.

Pří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_keyŘetězecPovinné

Klíč řazení.

Příklad: "example"

sourceŘetězecPovinné

Zdroj zaznamenané aktivity.

Omezení

enum: ["results", "autocomplete"]

Příklad: "results"

Další pole: Ne

Souhrn — Analytika a pravidla vyhledávání — Odpověď

OverviewData · Pole, typy a omezení dat přijímaných nebo vracených API.

click_through_rateČísloPovinné: Míra prokliku pro vybraná data vyhledávání.

Příklad: 0
clicked_searchesCelé čísloPovinné: Počet vyhledávání s kliknutím.

Příklad: 1
recentPole <RecentSearchData > Povinné: Informace o nedávných vyhledáváních.

Pří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 vyhledávání.

Příklad: 1
zero_result_rateČísloPovinné: Podíl vyhledávání bez výsledků.

Příklad: 0
zero_resultsCelé čísloPovinné: Počet vyhledávání bez výsledků.

Příklad: 1

Další pole: Ne

Řazení vybrané pro výsledky

QueryMetricSort · Pole, typy a omezení dat přijímaných nebo vracených API.

Řetězec

Omezení

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

Další pole: Ano

Informace o nedávných vyhledáváních

RecentSearchData · Schéma · Datová schémata: Analytika a pravidla vyhledávání

is_zero_resultsLogická hodnotaPovinné

Zda vyhledávání nevrátilo žádné výsledky.

Příklad: false

locale_codeŘetězecPovinné

Kód jazyka.

Příklad: "en"

occurred_atŘetězecPovinné

Datum a čas události.

format: "date-time"

Příklad: "2026-01-01T12:00:00Z"

query_displayŘetězecPovinné

Vyhledávací fráze zobrazená správci.

Příklad: "example"

query_hashŘetězecPovinné

Stabilní identifikátor seskupené vyhledávací fráze.

Příklad: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

Příklad: "example"

result_countCelé čísloPovinné

Počet výsledků vyhledávání.

Příklad: 1

sourceŘetězecPovinné

Zdroj zaznamenané aktivity.

Omezení

enum: ["results", "autocomplete"]

Příklad: "results"

Další pole: Ne

Zaznamenané výsledky vyhledávání

ResultSnapshotData · Schéma · Datová schémata: Analytika a pravidla vyhledávání

clickedLogická hodnotaPovinné

Zda bylo na výsledek kliknuto.

Příklad: false

entity_idŘetězecPovinné

Identifikátor odkazované entity.

Příklad: "example"

entity_typeŘetězecPovinné

Typ odkazované entity.

Omezení

enum: ["product", "category"]

Příklad: "product"

image_urlŘetězec nullPovinné

URL obrázku.

Příklad: "https://example.invalid/product.jpg"

numberŘetězec nullPovinné

Číslo objednávky nebo zákaznického požadavku určené pro uživatele.

Příklad: "example"

placement_sourceŘetězecPovinné

Zdroj vytvoření objednávky.

Omezení

enum: ["organic", "merchandising"]

Příklad: "organic"

positionCelé čísloPovinné

Pozice v seřazeném seznamu.

Příklad: 1

skuŘetězecPovinné

Skladový kód položky.

Příklad: "example"

slugŘetězecPovinné

Úsek cesty URL ve vybraném jazyce.

Příklad: "example"

titleŘetězecPovinné

Název ve vybraném jazyce.

Příklad: "example"

Další pole: Ne

Vytvořit · Pravidla — Analytika a pravidla vyhledávání — Tělo požadavku

RuleCreate · Pole, typy a omezení dat přijímaných nebo vracených API.

category_idsPole <Řetězec> Volitelné

Identifikátory souvisejících kategorií.

maxItems: 100

Pole:minLength: 1maxLength: 63

enabledLogická hodnotaVolitelné

Zda je nastavení zapnuto.

Výchozí hodnota: false

market_idsPole <Řetězec> Volitelné

Identifikátory vybraných trhů.

maxItems: 1000

Pole:minLength: 1maxLength: 63

market_scopeŘetězecVolitelné

Zda zdroj platí pro všechny, nebo jen vybrané trhy.

Omezení

enum: ["all", "selected"]

nameŘetězecPovinné

Název zdroje v příslušném kontextu.

minLength: 1maxLength: 160

Příklad: "Example"

phrasesPole <Řetězec> Povinné

Fráze používané pravidlem vyhledávání.

minItems: 1maxItems: 20

Pole:minLength: 1maxLength: 255

Příklad: ["example"]

product_idsPole <Řetězec> Volitelné

Identifikátory souvisejících produktů.

maxItems: 100

Pole:minLength: 1maxLength: 63

Příklad: ["example"]

Další pole: Ne

Načíst · Pravidla — Analytika a pravidla vyhledávání — Odpověď

RuleDetailData · Pole, typy a omezení dat přijímaných nebo vracených API.

category_idsPole <Řetězec> Povinné

Identifikátory souvisejících kategorií.

Příklad: ["example"]

created_atŘetězecPovinné

Čas vytvoření.

format: "date-time"

Příklad: "2026-01-01T12:00:00Z"

enabledLogická hodnotaPovinné

Zda je nastavení zapnuto.

Příklad: true

idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (RuleDetailData).

Příklad: "example"

is_availableLogická hodnotaPovinné

Zda je položka v tomto kontextu dostupná.

Příklad: true

market_idsPole <Řetězec> Povinné

Identifikátory vybraných trhů.

Příklad: ["example"]

market_scopeŘetězecPovinné

Zda zdroj platí pro všechny, nebo jen vybrané trhy.

Omezení

enum: ["all", "selected"]

Příklad: "all"

nameŘetězecPovinné

Název zdroje v příslušném kontextu.

Příklad: "Example"

phrase_groupsPole <RulePhraseGroupData > Povinné

Skupiny frází pravidla vyhledávání.

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

product_idsPole <Řetězec> Povinné

Identifikátory souvisejících produktů.

Příklad: ["example"]

updated_atŘetězecPovinné

Čas poslední aktualizace.

format: "date-time"

Příklad: "2026-01-01T12:00:00Z"

versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

Příklad: 1

Další pole: Ne

Skupiny frází pravidla vyhledávání

RulePhraseGroupData · Schéma · Datová schémata: Analytika a pravidla vyhledávání

localeŘetězecPovinné: Jazyk vybraný pro tento požadavek.

Příklad: "en"
phrasesPole <Řetězec> Povinné: Fráze používané pravidlem vyhledávání.

Příklad: ["example"]

Další pole: Ne

Vypsat · Pravidla — Analytika a pravidla vyhledávání — Odpověď

RuleSummaryData · Pole, typy a omezení dat přijímaných nebo vracených API.

created_atŘetězecPovinné

Čas vytvoření.

format: "date-time"

Příklad: "2026-01-01T12:00:00Z"

enabledLogická hodnotaPovinné

Zda je nastavení zapnuto.

Příklad: true

idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (RuleSummaryData).

Příklad: "example"

is_availableLogická hodnotaPovinné

Zda je položka v tomto kontextu dostupná.

Příklad: true

market_scopeŘetězecPovinné

Zda zdroj platí pro všechny, nebo jen vybrané trhy.

Omezení

enum: ["all", "selected"]

Příklad: "all"

nameŘetězecPovinné

Název zdroje v příslušném kontextu.

Příklad: "Example"

updated_atŘetězecPovinné

Čas poslední aktualizace.

format: "date-time"

Příklad: "2026-01-01T12:00:00Z"

versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

Příklad: 1

Další pole: Ne

Upravit · Pravidla — Analytika a pravidla vyhledávání — Tělo požadavku

RuleUpdate · Pole, typy a omezení dat přijímaných nebo vracených API.

category_idsPole <Řetězec> Volitelné

Identifikátory souvisejících kategorií.

maxItems: 100

Pole:minLength: 1maxLength: 63

enabledLogická hodnotaVolitelné

Zda je nastavení zapnuto.

expected_versionCelé čísloPovinné

Verze načtená před zápisem; při neshodě se aktualizace odmítne.

minimum: 1maximum: 2147483647

Příklad: 1

market_idsPole <Řetězec> Volitelné

Identifikátory vybraných trhů.

maxItems: 1000

Pole:minLength: 1maxLength: 63

market_scopeŘetězecVolitelné

Zda zdroj platí pro všechny, nebo jen vybrané trhy.

Omezení

enum: ["all", "selected"]

nameŘetězecVolitelné

Název zdroje v příslušném kontextu.

minLength: 1maxLength: 160

Příklad: "Example"

phrasesPole <Řetězec> Volitelné

Fráze používané pravidlem vyhledávání.

maxItems: 20

Pole:minLength: 1maxLength: 255

product_idsPole <Řetězec> Volitelné

Identifikátory souvisejících produktů.

maxItems: 100

Pole:minLength: 1maxLength: 63

Další pole: Ne

Filtr vybírající vyhledávání s výskyty bez výsledků nebo bez takových výskytů

ZeroResultScope · Pole, typy a omezení dat přijímaných nebo vracených API.

Řetězec

Omezení

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

Další pole: Ano