Tietoskeemat: Hakuanalytiikka ja säännöt

Tietoskeemat: Hakuanalytiikka ja säännöt. API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

Tietoskeemat

Vastauksen metatiedot

AnalyticsMeta · Skeema · Tietoskeemat: Hakuanalytiikka ja säännöt

periodAnalyticsPeriodData Pakollinen: Raportointijakso ja sen rajat.

Esimerkki: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idMerkkijonoPakollinen: Tapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.

minLength: 1maxLength: 100

Esimerkki: "example"

Lisäkentät: Ei

Raportointijakso ja sen rajat

AnalyticsPeriodData · Skeema · Tietoskeemat: Hakuanalytiikka ja säännöt

as_ofMerkkijonoPakollinen: Ajankohta, jota raportoidut tiedot koskevat.

format: "date-time"

Esimerkki: "2026-01-02T00:00:00Z"
daysKokonaislukuPakollinen: Raportointijakso päivinä.

Esimerkki: 1
started_atMerkkijonoPakollinen: Alkamispäivä ja -aika.

format: "date-time"

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

Lisäkentät: Ei

Listaa · Hakukyselyt — Hakuanalytiikka ja säännöt — Vastaus

AnalyticsResponse_list_MetricData__ · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

dataTaulukko <MetricData > Pakollinen: Vastausesimerkki · AnalyticsResponse_list_MetricData__.

Esimerkki: [{"clicks":1,"last_seen_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","searches":1,"zero_results":1}]
metaAnalyticsPageMeta AnalyticsMeta Pakollinen: Vastauksen metatiedot.

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

Lisäkentät: Ei

Hae · Hakukyselyt — Hakuanalytiikka ja säännöt — Vastaus

AnalyticsResponse_list_OccurrenceData__ · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

dataTaulukko <OccurrenceData > Pakollinen: Vastausesimerkki · AnalyticsResponse_list_OccurrenceData__.

Esimerkki: [{"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 Pakollinen: Vastauksen metatiedot.

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

Lisäkentät: Ei

Yhteenveto — Hakuanalytiikka ja säännöt — Vastaus

AnalyticsResponse_OverviewData_ · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

dataOverviewData Pakollinen: Vastausesimerkki · OverviewData.

Esimerkki: {"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 Pakollinen: Vastauksen metatiedot.

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

Lisäkentät: Ei

Listaa · Säännöt — Hakuanalytiikka ja säännöt — Vastaus

ApiResponse_list_RuleSummaryData__ · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

dataTaulukko <RuleSummaryData > Pakollinen: Vastausesimerkki · ApiResponse_list_RuleSummaryData__.

Esimerkki: [{"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 Pakollinen: Vastauksen metatiedot.

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

Lisäkentät: Ei

Hae · Säännöt — Hakuanalytiikka ja säännöt — Vastaus

ApiResponse_RuleDetailData_ · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

dataRuleDetailData Pakollinen: Vastausesimerkki · RuleDetailData.

Esimerkki: {"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 Pakollinen: Vastauksen metatiedot.

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

Lisäkentät: Ei

Listaa · Hakukyselyt — Hakuanalytiikka ja säännöt — Vastaus

MetricData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

clicksKokonaislukuPakollinen: Klikkausten määrä.

Esimerkki: 1
last_seen_atMerkkijonoPakollinen: Viimeisimmän esiintymän ajankohta.

format: "date-time"

Esimerkki: "2026-01-01T12:00:00Z"
query_displayMerkkijonoPakollinen: Ylläpitäjälle näytetty hakuilmaus.

Esimerkki: "example"
query_hashMerkkijonoPakollinen: Ryhmitellyn hakuilmauksen vakaa tunniste.

Esimerkki: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
searchesKokonaislukuPakollinen: Hakujen määrä.

Esimerkki: 1
zero_resultsKokonaislukuPakollinen: Ilman tuloksia jääneiden hakujen määrä.

Esimerkki: 1

Lisäkentät: Ei

Hae · Hakukyselyt — Hakuanalytiikka ja säännöt — Vastaus

OccurrenceData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

category_idMerkkijono nullPakollinen

Kategorian tunniste.

Esimerkki: "example"

category_result_countKokonaislukuPakollinen

Kategoriatulosten määrä.

Esimerkki: 1

currency_codeMerkkijonoPakollinen

Valuuttakoodi.

Esimerkki: "PLN"

is_zero_resultsTotuusarvoPakollinen

Palauttiko haku nolla tulosta.

Esimerkki: false

locale_codeMerkkijonoPakollinen

Kielikoodi.

Esimerkki: "en"

market_idMerkkijonoPakollinen

Kontekstipäätepisteen palauttama markkinatunniste.

Esimerkki: "example"

max_priceMerkkijono nullPakollinen

Raportoidun vaihteluvälin korkein hinta.

Esimerkki: "0.00"

min_priceMerkkijono nullPakollinen

Raportoidun vaihteluvälin alin hinta.

Esimerkki: "0.00"

occurred_atMerkkijonoPakollinen

Tapahtuman päivämäärä ja aika.

format: "date-time"

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

pageKokonaislukuPakollinen

CMS-sivun tiedot.

Esimerkki: 1

product_result_countKokonaislukuPakollinen

Tuotehakutulosten määrä.

Esimerkki: 1

query_displayMerkkijonoPakollinen

Ylläpitäjälle näytetty hakuilmaus.

Esimerkki: "example"

request_idMerkkijonoPakollinen

Tapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.

Esimerkki: "example"

resultsTaulukko <ResultSnapshotData > nullPakollinen

Kirjatut hakutulokset.

Esimerkki:

[{"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_keyMerkkijonoPakollinen

Lajitteluavain.

Esimerkki: "example"

sourceMerkkijonoPakollinen

Kirjatun toiminnan lähde.

Rajoitukset

enum: ["results", "autocomplete"]

Esimerkki: "results"

Lisäkentät: Ei

Yhteenveto — Hakuanalytiikka ja säännöt — Vastaus

OverviewData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

click_through_rateLukuPakollinen: Valittujen hakutietojen klikkausprosentti.

Esimerkki: 0
clicked_searchesKokonaislukuPakollinen: Klikkaukseen johtaneiden hakujen määrä.

Esimerkki: 1
recentTaulukko <RecentSearchData > Pakollinen: Viimeaikaisten hakujen tiedot.

Esimerkki: [{"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"}]
searchesKokonaislukuPakollinen: Hakujen määrä.

Esimerkki: 1
zero_result_rateLukuPakollinen: Ilman tuloksia jääneiden hakujen osuus.

Esimerkki: 0
zero_resultsKokonaislukuPakollinen: Ilman tuloksia jääneiden hakujen määrä.

Esimerkki: 1

Lisäkentät: Ei

Tuloksille valittu lajittelujärjestys

QueryMetricSort · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

Merkkijono

Rajoitukset

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

Lisäkentät: Kyllä

Viimeaikaisten hakujen tiedot

RecentSearchData · Skeema · Tietoskeemat: Hakuanalytiikka ja säännöt

is_zero_resultsTotuusarvoPakollinen

Palauttiko haku nolla tulosta.

Esimerkki: false

locale_codeMerkkijonoPakollinen

Kielikoodi.

Esimerkki: "en"

occurred_atMerkkijonoPakollinen

Tapahtuman päivämäärä ja aika.

format: "date-time"

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

query_displayMerkkijonoPakollinen

Ylläpitäjälle näytetty hakuilmaus.

Esimerkki: "example"

query_hashMerkkijonoPakollinen

Ryhmitellyn hakuilmauksen vakaa tunniste.

Esimerkki: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idMerkkijonoPakollinen

Tapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.

Esimerkki: "example"

result_countKokonaislukuPakollinen

Hakutulosten määrä.

Esimerkki: 1

sourceMerkkijonoPakollinen

Kirjatun toiminnan lähde.

Rajoitukset

enum: ["results", "autocomplete"]

Esimerkki: "results"

Lisäkentät: Ei

Kirjatut hakutulokset

ResultSnapshotData · Skeema · Tietoskeemat: Hakuanalytiikka ja säännöt

clickedTotuusarvoPakollinen

Klikattiinko tulosta.

Esimerkki: false

entity_idMerkkijonoPakollinen

Viitatun entiteetin tunniste.

Esimerkki: "example"

entity_typeMerkkijonoPakollinen

Viitatun entiteetin tyyppi.

Rajoitukset

enum: ["product", "category"]

Esimerkki: "product"

image_urlMerkkijono nullPakollinen

Kuvan URL-osoite.

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

numberMerkkijono nullPakollinen

Ihmiselle tarkoitettu tilaus- tai tapausnumero.

Esimerkki: "example"

placement_sourceMerkkijonoPakollinen

Lähde, josta tilaus tehtiin.

Rajoitukset

enum: ["organic", "merchandising"]

Esimerkki: "organic"

positionKokonaislukuPakollinen

Sijainti järjestetyssä kokoelmassa.

Esimerkki: 1

skuMerkkijonoPakollinen

Varastonimikkeen SKU-koodi.

Esimerkki: "example"

slugMerkkijonoPakollinen

URL-polun osa valitulla kielellä.

Esimerkki: "example"

titleMerkkijonoPakollinen

Otsikko valitulla kielellä.

Esimerkki: "example"

Lisäkentät: Ei

Luo · Säännöt — Hakuanalytiikka ja säännöt — Pyynnön sisältö

RuleCreate · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

category_idsTaulukko <Merkkijono> Valinnainen

Liittyvien kategorioiden tunnisteet.

maxItems: 100

Taulukko:minLength: 1maxLength: 63

enabledTotuusarvoValinnainen

Onko tämä asetus käytössä.

Oletus: false

market_idsTaulukko <Merkkijono> Valinnainen

Valittujen markkina-alueiden tunnisteet.

maxItems: 1000

Taulukko:minLength: 1maxLength: 63

market_scopeMerkkijonoValinnainen

Koskeeko resurssi kaikkia vai valittuja markkina-alueita.

Rajoitukset

enum: ["all", "selected"]

nameMerkkijonoPakollinen

Resurssin nimi kyseisessä kontekstissa.

minLength: 1maxLength: 160

Esimerkki: "Example"

phrasesTaulukko <Merkkijono> Pakollinen

Hakusäännön käyttämät ilmaukset.

minItems: 1maxItems: 20

Taulukko:minLength: 1maxLength: 255

Esimerkki: ["example"]

product_idsTaulukko <Merkkijono> Valinnainen

Liittyvien tuotteiden tunnisteet.

maxItems: 100

Taulukko:minLength: 1maxLength: 63

Esimerkki: ["example"]

Lisäkentät: Ei

Hae · Säännöt — Hakuanalytiikka ja säännöt — Vastaus

RuleDetailData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

category_idsTaulukko <Merkkijono> Pakollinen

Liittyvien kategorioiden tunnisteet.

Esimerkki: ["example"]

created_atMerkkijonoPakollinen

Luontiajankohta.

format: "date-time"

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

enabledTotuusarvoPakollinen

Onko tämä asetus käytössä.

Esimerkki: true

idMerkkijonoPakollinen

Resurssin tunniste; säilytä se palautetussa muodossa. (RuleDetailData).

Esimerkki: "example"

is_availableTotuusarvoPakollinen

Onko kohde saatavilla tässä kontekstissa.

Esimerkki: true

market_idsTaulukko <Merkkijono> Pakollinen

Valittujen markkina-alueiden tunnisteet.

Esimerkki: ["example"]

market_scopeMerkkijonoPakollinen

Koskeeko resurssi kaikkia vai valittuja markkina-alueita.

Rajoitukset

enum: ["all", "selected"]

Esimerkki: "all"

nameMerkkijonoPakollinen

Resurssin nimi kyseisessä kontekstissa.

Esimerkki: "Example"

phrase_groupsTaulukko <RulePhraseGroupData > Pakollinen

Hakusäännön ilmausryhmät.

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

product_idsTaulukko <Merkkijono> Pakollinen

Liittyvien tuotteiden tunnisteet.

Esimerkki: ["example"]

updated_atMerkkijonoPakollinen

Viimeisimmän päivityksen ajankohta.

format: "date-time"

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

versionKokonaislukuPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 1

Lisäkentät: Ei

Hakusäännön ilmausryhmät

RulePhraseGroupData · Skeema · Tietoskeemat: Hakuanalytiikka ja säännöt

localeMerkkijonoPakollinen: Tälle pyynnölle valittu kieli.

Esimerkki: "en"
phrasesTaulukko <Merkkijono> Pakollinen: Hakusäännön käyttämät ilmaukset.

Esimerkki: ["example"]

Lisäkentät: Ei

Listaa · Säännöt — Hakuanalytiikka ja säännöt — Vastaus

RuleSummaryData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

created_atMerkkijonoPakollinen

Luontiajankohta.

format: "date-time"

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

enabledTotuusarvoPakollinen

Onko tämä asetus käytössä.

Esimerkki: true

idMerkkijonoPakollinen

Resurssin tunniste; säilytä se palautetussa muodossa. (RuleSummaryData).

Esimerkki: "example"

is_availableTotuusarvoPakollinen

Onko kohde saatavilla tässä kontekstissa.

Esimerkki: true

market_scopeMerkkijonoPakollinen

Koskeeko resurssi kaikkia vai valittuja markkina-alueita.

Rajoitukset

enum: ["all", "selected"]

Esimerkki: "all"

nameMerkkijonoPakollinen

Resurssin nimi kyseisessä kontekstissa.

Esimerkki: "Example"

updated_atMerkkijonoPakollinen

Viimeisimmän päivityksen ajankohta.

format: "date-time"

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

versionKokonaislukuPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 1

Lisäkentät: Ei

Päivitä · Säännöt — Hakuanalytiikka ja säännöt — Pyynnön sisältö

RuleUpdate · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

category_idsTaulukko <Merkkijono> Valinnainen

Liittyvien kategorioiden tunnisteet.

maxItems: 100

Taulukko:minLength: 1maxLength: 63

enabledTotuusarvoValinnainen

Onko tämä asetus käytössä.

expected_versionKokonaislukuPakollinen

Ennen kirjoitusta luettu versio; ristiriita hylkää päivityksen.

minimum: 1maximum: 2147483647

Esimerkki: 1

market_idsTaulukko <Merkkijono> Valinnainen

Valittujen markkina-alueiden tunnisteet.

maxItems: 1000

Taulukko:minLength: 1maxLength: 63

market_scopeMerkkijonoValinnainen

Koskeeko resurssi kaikkia vai valittuja markkina-alueita.

Rajoitukset

enum: ["all", "selected"]

nameMerkkijonoValinnainen

Resurssin nimi kyseisessä kontekstissa.

minLength: 1maxLength: 160

Esimerkki: "Example"

phrasesTaulukko <Merkkijono> Valinnainen

Hakusäännön käyttämät ilmaukset.

maxItems: 20

Taulukko:minLength: 1maxLength: 255

product_idsTaulukko <Merkkijono> Valinnainen

Liittyvien tuotteiden tunnisteet.

maxItems: 100

Taulukko:minLength: 1maxLength: 63

Lisäkentät: Ei

Suodatin, joka valitsee hakuja sen mukaan, onko niillä tuloksettomia esiintymiä

ZeroResultScope · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

Merkkijono

Rajoitukset

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

Lisäkentät: Kyllä