Duomenų schemos: Paieškos analitika ir taisyklės

Duomenų schemos: Paieškos analitika ir taisyklės. API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

Duomenų schemos

Atsakymo metaduomenys

AnalyticsMeta · Schema · Duomenų schemos: Paieškos analitika ir taisyklės

periodAnalyticsPeriodData Privalomas: Ataskaitos laikotarpis ir jo ribos.

Pavyzdys: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idEilutėPrivalomas: Prašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.

minLength: 1maxLength: 100

Pavyzdys: "example"

Papildomi laukai: Ne

Ataskaitos laikotarpis ir jo ribos

AnalyticsPeriodData · Schema · Duomenų schemos: Paieškos analitika ir taisyklės

as_ofEilutėPrivalomas: Laikas, kuriam galioja pateikti duomenys.

format: "date-time"

Pavyzdys: "2026-01-02T00:00:00Z"
daysSveikasis skaičiusPrivalomas: Ataskaitos laikotarpis dienomis.

Pavyzdys: 1
started_atEilutėPrivalomas: Pradžios data ir laikas.

format: "date-time"

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

Papildomi laukai: Ne

Sąrašas · Paieškos užklausos — Paieškos analitika ir taisyklės — Atsakymas

AnalyticsResponse_list_MetricData__ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

dataMasyvas <MetricData > Privalomas: Atsakymo pavyzdys · AnalyticsResponse_list_MetricData__.

Pavyzdys: [{"clicks":1,"last_seen_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","searches":1,"zero_results":1}]
metaAnalyticsPageMeta AnalyticsMeta Privalomas: Atsakymo metaduomenys.

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

Papildomi laukai: Ne

Gauti · Paieškos užklausos — Paieškos analitika ir taisyklės — Atsakymas

AnalyticsResponse_list_OccurrenceData__ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

dataMasyvas <OccurrenceData > Privalomas: Atsakymo pavyzdys · AnalyticsResponse_list_OccurrenceData__.

Pavyzdys: [{"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 Privalomas: Atsakymo metaduomenys.

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

Papildomi laukai: Ne

Santrauka — Paieškos analitika ir taisyklės — Atsakymas

AnalyticsResponse_OverviewData_ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

dataOverviewData Privalomas: Atsakymo pavyzdys · OverviewData.

Pavyzdys: {"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 Privalomas: Atsakymo metaduomenys.

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

Papildomi laukai: Ne

Sąrašas · Taisyklės — Paieškos analitika ir taisyklės — Atsakymas

ApiResponse_list_RuleSummaryData__ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

dataMasyvas <RuleSummaryData > Privalomas: Atsakymo pavyzdys · ApiResponse_list_RuleSummaryData__.

Pavyzdys: [{"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 Privalomas: Atsakymo metaduomenys.

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

Papildomi laukai: Ne

Gauti · Taisyklės — Paieškos analitika ir taisyklės — Atsakymas

ApiResponse_RuleDetailData_ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

dataRuleDetailData Privalomas: Atsakymo pavyzdys · RuleDetailData.

Pavyzdys: {"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 Privalomas: Atsakymo metaduomenys.

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

Papildomi laukai: Ne

Sąrašas · Paieškos užklausos — Paieškos analitika ir taisyklės — Atsakymas

MetricData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

clicksSveikasis skaičiusPrivalomas: Paspaudimų skaičius.

Pavyzdys: 1
last_seen_atEilutėPrivalomas: Paskutinio pasirodymo laikas.

format: "date-time"

Pavyzdys: "2026-01-01T12:00:00Z"
query_displayEilutėPrivalomas: Administratoriui rodoma paieškos frazė.

Pavyzdys: "example"
query_hashEilutėPrivalomas: Stabilus sugrupuotos paieškos frazės identifikatorius.

Pavyzdys: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
searchesSveikasis skaičiusPrivalomas: Paieškų skaičius.

Pavyzdys: 1
zero_resultsSveikasis skaičiusPrivalomas: Paieškų be rezultatų skaičius.

Pavyzdys: 1

Papildomi laukai: Ne

Gauti · Paieškos užklausos — Paieškos analitika ir taisyklės — Atsakymas

OccurrenceData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

category_idEilutė nullPrivalomas

Kategorijos identifikatorius.

Pavyzdys: "example"

category_result_countSveikasis skaičiusPrivalomas

Kategorijų rezultatų skaičius.

Pavyzdys: 1

currency_codeEilutėPrivalomas

Valiutos kodas.

Pavyzdys: "PLN"

is_zero_resultsLoginė reikšmėPrivalomas

Ar paieška negrąžino rezultatų.

Pavyzdys: false

locale_codeEilutėPrivalomas

Kalbos kodas.

Pavyzdys: "en"

market_idEilutėPrivalomas

Konteksto prieigos taško grąžintas rinkos identifikatorius.

Pavyzdys: "example"

max_priceEilutė nullPrivalomas

Didžiausia nurodyto intervalo kaina.

Pavyzdys: "0.00"

min_priceEilutė nullPrivalomas

Mažiausia nurodyto intervalo kaina.

Pavyzdys: "0.00"

occurred_atEilutėPrivalomas

Įvykio data ir laikas.

format: "date-time"

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

pageSveikasis skaičiusPrivalomas

CMS puslapio informacija.

Pavyzdys: 1

product_result_countSveikasis skaičiusPrivalomas

Produktų paieškos rezultatų skaičius.

Pavyzdys: 1

query_displayEilutėPrivalomas

Administratoriui rodoma paieškos frazė.

Pavyzdys: "example"

request_idEilutėPrivalomas

Prašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.

Pavyzdys: "example"

resultsMasyvas <ResultSnapshotData > nullPrivalomas

Užregistruoti paieškos rezultatai.

Pavyzdys:

[{"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_keyEilutėPrivalomas

Rikiavimo raktas.

Pavyzdys: "example"

sourceEilutėPrivalomas

Užregistruotos veiklos šaltinis.

Apribojimai

enum: ["results", "autocomplete"]

Pavyzdys: "results"

Papildomi laukai: Ne

Santrauka — Paieškos analitika ir taisyklės — Atsakymas

OverviewData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

click_through_rateSkaičiusPrivalomas: Pasirinktų paieškos duomenų paspaudimų rodiklis.

Pavyzdys: 0
clicked_searchesSveikasis skaičiusPrivalomas: Paieškų su paspaudimu skaičius.

Pavyzdys: 1
recentMasyvas <RecentSearchData > Privalomas: Naujausių paieškų informacija.

Pavyzdys: [{"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"}]
searchesSveikasis skaičiusPrivalomas: Paieškų skaičius.

Pavyzdys: 1
zero_result_rateSkaičiusPrivalomas: Paieškų, kurios negrąžino rezultatų, dalis.

Pavyzdys: 0
zero_resultsSveikasis skaičiusPrivalomas: Paieškų be rezultatų skaičius.

Pavyzdys: 1

Papildomi laukai: Ne

Rezultatams pasirinkta rikiavimo tvarka

QueryMetricSort · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

Eilutė

Apribojimai

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

Papildomi laukai: Taip

Naujausių paieškų informacija

RecentSearchData · Schema · Duomenų schemos: Paieškos analitika ir taisyklės

is_zero_resultsLoginė reikšmėPrivalomas

Ar paieška negrąžino rezultatų.

Pavyzdys: false

locale_codeEilutėPrivalomas

Kalbos kodas.

Pavyzdys: "en"

occurred_atEilutėPrivalomas

Įvykio data ir laikas.

format: "date-time"

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

query_displayEilutėPrivalomas

Administratoriui rodoma paieškos frazė.

Pavyzdys: "example"

query_hashEilutėPrivalomas

Stabilus sugrupuotos paieškos frazės identifikatorius.

Pavyzdys: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idEilutėPrivalomas

Prašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.

Pavyzdys: "example"

result_countSveikasis skaičiusPrivalomas

Paieškos rezultatų skaičius.

Pavyzdys: 1

sourceEilutėPrivalomas

Užregistruotos veiklos šaltinis.

Apribojimai

enum: ["results", "autocomplete"]

Pavyzdys: "results"

Papildomi laukai: Ne

Užregistruoti paieškos rezultatai

ResultSnapshotData · Schema · Duomenų schemos: Paieškos analitika ir taisyklės

clickedLoginė reikšmėPrivalomas

Ar rezultatas buvo paspaustas.

Pavyzdys: false

entity_idEilutėPrivalomas

Nurodyto objekto identifikatorius.

Pavyzdys: "example"

entity_typeEilutėPrivalomas

Nurodyto objekto tipas.

Apribojimai

enum: ["product", "category"]

Pavyzdys: "product"

image_urlEilutė nullPrivalomas

Paveikslėlio URL.

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

numberEilutė nullPrivalomas

Žmogui rodomas užsakymo arba prašymo numeris.

Pavyzdys: "example"

placement_sourceEilutėPrivalomas

Šaltinis, kuriame pateiktas užsakymas.

Apribojimai

enum: ["organic", "merchandising"]

Pavyzdys: "organic"

positionSveikasis skaičiusPrivalomas

Pozicija surikiuotame rinkinyje.

Pavyzdys: 1

skuEilutėPrivalomas

Atsargų apskaitos vieneto kodas.

Pavyzdys: "example"

slugEilutėPrivalomas

URL kelio segmentas pasirinkta kalba.

Pavyzdys: "example"

titleEilutėPrivalomas

Pavadinimas pasirinkta kalba.

Pavyzdys: "example"

Papildomi laukai: Ne

Sukurti · Taisyklės — Paieškos analitika ir taisyklės — Užklausos turinys

RuleCreate · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

category_idsMasyvas <Eilutė> Neprivalomas

Susijusių kategorijų identifikatoriai.

maxItems: 100

Masyvas:minLength: 1maxLength: 63

enabledLoginė reikšmėNeprivalomas

Ar šis nustatymas įjungtas.

Numatytoji reikšmė: false

market_idsMasyvas <Eilutė> Neprivalomas

Pasirinktų rinkų identifikatoriai.

maxItems: 1000

Masyvas:minLength: 1maxLength: 63

market_scopeEilutėNeprivalomas

Ar išteklius taikomas visoms, ar pasirinktoms rinkoms.

Apribojimai

enum: ["all", "selected"]

nameEilutėPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

minLength: 1maxLength: 160

Pavyzdys: "Example"

phrasesMasyvas <Eilutė> Privalomas

Paieškos taisyklėje naudojamos frazės.

minItems: 1maxItems: 20

Masyvas:minLength: 1maxLength: 255

Pavyzdys: ["example"]

product_idsMasyvas <Eilutė> Neprivalomas

Susijusių produktų identifikatoriai.

maxItems: 100

Masyvas:minLength: 1maxLength: 63

Pavyzdys: ["example"]

Papildomi laukai: Ne

Gauti · Taisyklės — Paieškos analitika ir taisyklės — Atsakymas

RuleDetailData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

category_idsMasyvas <Eilutė> Privalomas

Susijusių kategorijų identifikatoriai.

Pavyzdys: ["example"]

created_atEilutėPrivalomas

Sukūrimo laikas.

format: "date-time"

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

enabledLoginė reikšmėPrivalomas

Ar šis nustatymas įjungtas.

Pavyzdys: true

idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. (RuleDetailData).

Pavyzdys: "example"

is_availableLoginė reikšmėPrivalomas

Ar elementas prieinamas šiame kontekste.

Pavyzdys: true

market_idsMasyvas <Eilutė> Privalomas

Pasirinktų rinkų identifikatoriai.

Pavyzdys: ["example"]

market_scopeEilutėPrivalomas

Ar išteklius taikomas visoms, ar pasirinktoms rinkoms.

Apribojimai

enum: ["all", "selected"]

Pavyzdys: "all"

nameEilutėPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

Pavyzdys: "Example"

phrase_groupsMasyvas <RulePhraseGroupData > Privalomas

Paieškos taisyklės frazių grupės.

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

product_idsMasyvas <Eilutė> Privalomas

Susijusių produktų identifikatoriai.

Pavyzdys: ["example"]

updated_atEilutėPrivalomas

Paskutinio atnaujinimo laikas.

format: "date-time"

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

versionSveikasis skaičiusPrivalomas

Ištekliaus versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 1

Papildomi laukai: Ne

Paieškos taisyklės frazių grupės

RulePhraseGroupData · Schema · Duomenų schemos: Paieškos analitika ir taisyklės

localeEilutėPrivalomas: Šiai užklausai pasirinkta kalba.

Pavyzdys: "en"
phrasesMasyvas <Eilutė> Privalomas: Paieškos taisyklėje naudojamos frazės.

Pavyzdys: ["example"]

Papildomi laukai: Ne

Sąrašas · Taisyklės — Paieškos analitika ir taisyklės — Atsakymas

RuleSummaryData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

created_atEilutėPrivalomas

Sukūrimo laikas.

format: "date-time"

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

enabledLoginė reikšmėPrivalomas

Ar šis nustatymas įjungtas.

Pavyzdys: true

idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. (RuleSummaryData).

Pavyzdys: "example"

is_availableLoginė reikšmėPrivalomas

Ar elementas prieinamas šiame kontekste.

Pavyzdys: true

market_scopeEilutėPrivalomas

Ar išteklius taikomas visoms, ar pasirinktoms rinkoms.

Apribojimai

enum: ["all", "selected"]

Pavyzdys: "all"

nameEilutėPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

Pavyzdys: "Example"

updated_atEilutėPrivalomas

Paskutinio atnaujinimo laikas.

format: "date-time"

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

versionSveikasis skaičiusPrivalomas

Ištekliaus versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 1

Papildomi laukai: Ne

Atnaujinti · Taisyklės — Paieškos analitika ir taisyklės — Užklausos turinys

RuleUpdate · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

category_idsMasyvas <Eilutė> Neprivalomas

Susijusių kategorijų identifikatoriai.

maxItems: 100

Masyvas:minLength: 1maxLength: 63

enabledLoginė reikšmėNeprivalomas

Ar šis nustatymas įjungtas.

expected_versionSveikasis skaičiusPrivalomas

Prieš įrašant perskaityta versija; neatitikimas atmeta pakeitimą.

minimum: 1maximum: 2147483647

Pavyzdys: 1

market_idsMasyvas <Eilutė> Neprivalomas

Pasirinktų rinkų identifikatoriai.

maxItems: 1000

Masyvas:minLength: 1maxLength: 63

market_scopeEilutėNeprivalomas

Ar išteklius taikomas visoms, ar pasirinktoms rinkoms.

Apribojimai

enum: ["all", "selected"]

nameEilutėNeprivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

minLength: 1maxLength: 160

Pavyzdys: "Example"

phrasesMasyvas <Eilutė> Neprivalomas

Paieškos taisyklėje naudojamos frazės.

maxItems: 20

Masyvas:minLength: 1maxLength: 255

product_idsMasyvas <Eilutė> Neprivalomas

Susijusių produktų identifikatoriai.

maxItems: 100

Masyvas:minLength: 1maxLength: 63

Papildomi laukai: Ne

Filtras, pasirenkantis paieškas su rezultatų neturinčiais pasikartojimais arba be jų

ZeroResultScope · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

Eilutė

Apribojimai

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

Papildomi laukai: Taip