Adatsémák: Keresési elemzések és szabályok

Adatsémák: Keresési elemzések és szabályok. Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

Adatsémák

A válasz metaadatai

AnalyticsMeta · Séma · Adatsémák: Keresési elemzések és szabályok

periodAnalyticsPeriodData Kötelező: A jelentési időszak és annak határai.

Példa: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idKarakterláncKötelező: Kérésazonosító; a válasz metaadataiban a HTTP-kérést azonosítja.

minLength: 1maxLength: 100

Példa: "example"

További mezők: Nem

A jelentési időszak és annak határai

AnalyticsPeriodData · Séma · Adatsémák: Keresési elemzések és szabályok

as_ofKarakterláncKötelező: Az időpont, amelyre a közölt adatok vonatkoznak.

format: "date-time"

Példa: "2026-01-02T00:00:00Z"
daysEgész számKötelező: A jelentési időszak napokban.

Példa: 1
started_atKarakterláncKötelező: A kezdés dátuma és időpontja.

format: "date-time"

Példa: "2026-01-01T00:00:00Z"

További mezők: Nem

Listázás · Keresési lekérdezések — Keresési elemzések és szabályok — Válasz

AnalyticsResponse_list_MetricData__ · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

dataTömb <MetricData > Kötelező: Példaválasz · AnalyticsResponse_list_MetricData__.

Példa: [{"clicks":1,"last_seen_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","searches":1,"zero_results":1}]
metaAnalyticsPageMeta AnalyticsMeta Kötelező: A válasz metaadatai.

Példa: {"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"}

További mezők: Nem

Lekérés · Keresési lekérdezések — Keresési elemzések és szabályok — Válasz

AnalyticsResponse_list_OccurrenceData__ · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

dataTömb <OccurrenceData > Kötelező: Példaválasz · AnalyticsResponse_list_OccurrenceData__.

Példa: [{"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 Kötelező: A válasz metaadatai.

Példa: {"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"}

További mezők: Nem

Összegzés — Keresési elemzések és szabályok — Válasz

AnalyticsResponse_OverviewData_ · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

dataOverviewData Kötelező: Példaválasz · OverviewData.

Példa: {"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 Kötelező: A válasz metaadatai.

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

További mezők: Nem

Listázás · Szabályok — Keresési elemzések és szabályok — Válasz

ApiResponse_list_RuleSummaryData__ · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

dataTömb <RuleSummaryData > Kötelező: Példaválasz · ApiResponse_list_RuleSummaryData__.

Példa: [{"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 Kötelező: A válasz metaadatai.

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

További mezők: Nem

Lekérés · Szabályok — Keresési elemzések és szabályok — Válasz

ApiResponse_RuleDetailData_ · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

dataRuleDetailData Kötelező: Példaválasz · RuleDetailData.

Példa: {"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 Kötelező: A válasz metaadatai.

Példa: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

További mezők: Nem

Listázás · Keresési lekérdezések — Keresési elemzések és szabályok — Válasz

MetricData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

clicksEgész számKötelező: Kattintások száma.

Példa: 1
last_seen_atKarakterláncKötelező: A legutóbbi előfordulás időpontja.

format: "date-time"

Példa: "2026-01-01T12:00:00Z"
query_displayKarakterláncKötelező: A rendszergazdának megjelenített keresőkifejezés.

Példa: "example"
query_hashKarakterláncKötelező: A csoportosított keresőkifejezés stabil azonosítója.

Példa: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
searchesEgész számKötelező: Keresések száma.

Példa: 1
zero_resultsEgész számKötelező: Találat nélküli keresések száma.

Példa: 1

További mezők: Nem

Lekérés · Keresési lekérdezések — Keresési elemzések és szabályok — Válasz

OccurrenceData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

category_idKarakterlánc nullKötelező

Kategóriaazonosító.

Példa: "example"

category_result_countEgész számKötelező

Kategóriatalálatok száma.

Példa: 1

currency_codeKarakterláncKötelező

Pénznemkód.

Példa: "PLN"

is_zero_resultsLogikai értékKötelező

Jelzi, hogy a keresés találat nélkül zárult-e.

Példa: false

locale_codeKarakterláncKötelező

Nyelvkód.

Példa: "en"

market_idKarakterláncKötelező

A környezetvégpont által visszaadott piacazonosító.

Példa: "example"

max_priceKarakterlánc nullKötelező

A közölt tartomány legmagasabb ára.

Példa: "0.00"

min_priceKarakterlánc nullKötelező

A közölt tartomány legalacsonyabb ára.

Példa: "0.00"

occurred_atKarakterláncKötelező

Az esemény dátuma és időpontja.

format: "date-time"

Példa: "2026-01-01T12:00:00Z"

pageEgész számKötelező

A CMS-oldal adatai.

Példa: 1

product_result_countEgész számKötelező

Termékkeresési találatok száma.

Példa: 1

query_displayKarakterláncKötelező

A rendszergazdának megjelenített keresőkifejezés.

Példa: "example"

request_idKarakterláncKötelező

Kérésazonosító; a válasz metaadataiban a HTTP-kérést azonosítja.

Példa: "example"

resultsTömb <ResultSnapshotData > nullKötelező

A rögzített keresési találatok.

Példa:

[{"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_keyKarakterláncKötelező

Rendezési kulcs.

Példa: "example"

sourceKarakterláncKötelező

A rögzített tevékenység forrása.

Korlátozások

enum: ["results", "autocomplete"]

Példa: "results"

További mezők: Nem

Összegzés — Keresési elemzések és szabályok — Válasz

OverviewData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

click_through_rateSzámKötelező: A kiválasztott keresési adatok átkattintási aránya.

Példa: 0
clicked_searchesEgész számKötelező: Kattintással járó keresések száma.

Példa: 1
recentTömb <RecentSearchData > Kötelező: A közelmúlt keresési adatai.

Példa: [{"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"}]
searchesEgész számKötelező: Keresések száma.

Példa: 1
zero_result_rateSzámKötelező: A találat nélküli keresések aránya.

Példa: 0
zero_resultsEgész számKötelező: Találat nélküli keresések száma.

Példa: 1

További mezők: Nem

A találatokhoz választott rendezési sorrend

QueryMetricSort · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

Karakterlánc

Korlátozások

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

További mezők: Igen

A közelmúlt keresési adatai

RecentSearchData · Séma · Adatsémák: Keresési elemzések és szabályok

is_zero_resultsLogikai értékKötelező

Jelzi, hogy a keresés találat nélkül zárult-e.

Példa: false

locale_codeKarakterláncKötelező

Nyelvkód.

Példa: "en"

occurred_atKarakterláncKötelező

Az esemény dátuma és időpontja.

format: "date-time"

Példa: "2026-01-01T12:00:00Z"

query_displayKarakterláncKötelező

A rendszergazdának megjelenített keresőkifejezés.

Példa: "example"

query_hashKarakterláncKötelező

A csoportosított keresőkifejezés stabil azonosítója.

Példa: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idKarakterláncKötelező

Kérésazonosító; a válasz metaadataiban a HTTP-kérést azonosítja.

Példa: "example"

result_countEgész számKötelező

Keresési találatok száma.

Példa: 1

sourceKarakterláncKötelező

A rögzített tevékenység forrása.

Korlátozások

enum: ["results", "autocomplete"]

Példa: "results"

További mezők: Nem

A rögzített keresési találatok

ResultSnapshotData · Séma · Adatsémák: Keresési elemzések és szabályok

clickedLogikai értékKötelező

Jelzi, hogy a találatra kattintottak-e.

Példa: false

entity_idKarakterláncKötelező

A hivatkozott entitás azonosítója.

Példa: "example"

entity_typeKarakterláncKötelező

A hivatkozott entitás típusa.

Korlátozások

enum: ["product", "category"]

Példa: "product"

image_urlKarakterlánc nullKötelező

A kép URL-je.

Példa: "https://example.invalid/product.jpg"

numberKarakterlánc nullKötelező

A rendelés vagy bejelentés felhasználóknak szánt száma.

Példa: "example"

placement_sourceKarakterláncKötelező

A rendelés leadásának forrása.

Korlátozások

enum: ["organic", "merchandising"]

Példa: "organic"

positionEgész számKötelező

Pozíció a rendezett gyűjteményben.

Példa: 1

skuKarakterláncKötelező

Készletnyilvántartási cikkszám.

Példa: "example"

slugKarakterláncKötelező

URL-útvonalszegmens a kiválasztott nyelven.

Példa: "example"

titleKarakterláncKötelező

Cím a kiválasztott nyelven.

Példa: "example"

További mezők: Nem

Létrehozás · Szabályok — Keresési elemzések és szabályok — Kérés törzse

RuleCreate · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

category_idsTömb <Karakterlánc> Nem kötelező

A kapcsolódó kategóriák azonosítói.

maxItems: 100

Tömb:minLength: 1maxLength: 63

enabledLogikai értékNem kötelező

Jelzi, hogy a beállítás engedélyezett-e.

Alapértelmezett: false

market_idsTömb <Karakterlánc> Nem kötelező

A kiválasztott piacok azonosítói.

maxItems: 1000

Tömb:minLength: 1maxLength: 63

market_scopeKarakterláncNem kötelező

Jelzi, hogy az erőforrás minden piacra vagy csak a kiválasztottakra vonatkozik-e.

Korlátozások

enum: ["all", "selected"]

nameKarakterláncKötelező

Az erőforrás neve az adott környezetben.

minLength: 1maxLength: 160

Példa: "Example"

phrasesTömb <Karakterlánc> Kötelező

A keresési szabály által használt kifejezések.

minItems: 1maxItems: 20

Tömb:minLength: 1maxLength: 255

Példa: ["example"]

product_idsTömb <Karakterlánc> Nem kötelező

A kapcsolódó termékek azonosítói.

maxItems: 100

Tömb:minLength: 1maxLength: 63

Példa: ["example"]

További mezők: Nem

Lekérés · Szabályok — Keresési elemzések és szabályok — Válasz

RuleDetailData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

category_idsTömb <Karakterlánc> Kötelező

A kapcsolódó kategóriák azonosítói.

Példa: ["example"]

created_atKarakterláncKötelező

A létrehozás időpontja.

format: "date-time"

Példa: "2026-01-01T12:00:00Z"

enabledLogikai értékKötelező

Jelzi, hogy a beállítás engedélyezett-e.

Példa: true

idKarakterláncKötelező

Erőforrás-azonosító; a visszaadott alakban őrizze meg. (RuleDetailData).

Példa: "example"

is_availableLogikai értékKötelező

Jelzi, hogy a tétel elérhető-e ebben a környezetben.

Példa: true

market_idsTömb <Karakterlánc> Kötelező

A kiválasztott piacok azonosítói.

Példa: ["example"]

market_scopeKarakterláncKötelező

Jelzi, hogy az erőforrás minden piacra vagy csak a kiválasztottakra vonatkozik-e.

Korlátozások

enum: ["all", "selected"]

Példa: "all"

nameKarakterláncKötelező

Az erőforrás neve az adott környezetben.

Példa: "Example"

phrase_groupsTömb <RulePhraseGroupData > Kötelező

A keresési szabály kifejezéscsoportjai.

Példa: [{"locale":"en","phrases":["example"]}]

product_idsTömb <Karakterlánc> Kötelező

A kapcsolódó termékek azonosítói.

Példa: ["example"]

updated_atKarakterláncKötelező

A legutóbbi módosítás időpontja.

format: "date-time"

Példa: "2026-01-01T12:00:00Z"

versionEgész számKötelező

Az erőforrás verziója az egyidejű módosítások ellenőrzéséhez.

Példa: 1

További mezők: Nem

A keresési szabály kifejezéscsoportjai

RulePhraseGroupData · Séma · Adatsémák: Keresési elemzések és szabályok

localeKarakterláncKötelező: A kéréshez kiválasztott nyelv.

Példa: "en"
phrasesTömb <Karakterlánc> Kötelező: A keresési szabály által használt kifejezések.

Példa: ["example"]

További mezők: Nem

Listázás · Szabályok — Keresési elemzések és szabályok — Válasz

RuleSummaryData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

created_atKarakterláncKötelező

A létrehozás időpontja.

format: "date-time"

Példa: "2026-01-01T12:00:00Z"

enabledLogikai értékKötelező

Jelzi, hogy a beállítás engedélyezett-e.

Példa: true

idKarakterláncKötelező

Erőforrás-azonosító; a visszaadott alakban őrizze meg. (RuleSummaryData).

Példa: "example"

is_availableLogikai értékKötelező

Jelzi, hogy a tétel elérhető-e ebben a környezetben.

Példa: true

market_scopeKarakterláncKötelező

Jelzi, hogy az erőforrás minden piacra vagy csak a kiválasztottakra vonatkozik-e.

Korlátozások

enum: ["all", "selected"]

Példa: "all"

nameKarakterláncKötelező

Az erőforrás neve az adott környezetben.

Példa: "Example"

updated_atKarakterláncKötelező

A legutóbbi módosítás időpontja.

format: "date-time"

Példa: "2026-01-01T12:00:00Z"

versionEgész számKötelező

Az erőforrás verziója az egyidejű módosítások ellenőrzéséhez.

Példa: 1

További mezők: Nem

Módosítás · Szabályok — Keresési elemzések és szabályok — Kérés törzse

RuleUpdate · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

category_idsTömb <Karakterlánc> Nem kötelező

A kapcsolódó kategóriák azonosítói.

maxItems: 100

Tömb:minLength: 1maxLength: 63

enabledLogikai értékNem kötelező

Jelzi, hogy a beállítás engedélyezett-e.

expected_versionEgész számKötelező

Az írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.

minimum: 1maximum: 2147483647

Példa: 1

market_idsTömb <Karakterlánc> Nem kötelező

A kiválasztott piacok azonosítói.

maxItems: 1000

Tömb:minLength: 1maxLength: 63

market_scopeKarakterláncNem kötelező

Jelzi, hogy az erőforrás minden piacra vagy csak a kiválasztottakra vonatkozik-e.

Korlátozások

enum: ["all", "selected"]

nameKarakterláncNem kötelező

Az erőforrás neve az adott környezetben.

minLength: 1maxLength: 160

Példa: "Example"

phrasesTömb <Karakterlánc> Nem kötelező

A keresési szabály által használt kifejezések.

maxItems: 20

Tömb:minLength: 1maxLength: 255

product_idsTömb <Karakterlánc> Nem kötelező

A kapcsolódó termékek azonosítói.

maxItems: 100

Tömb:minLength: 1maxLength: 63

További mezők: Nem

Találat nélküli előfordulásokat tartalmazó vagy nem tartalmazó keresések szűrője

ZeroResultScope · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

Karakterlánc

Korlátozások

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

További mezők: Igen