Sheme podataka: Analitika i pravila pretraživanja

Sheme podataka: Analitika i pravila pretraživanja. Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

Sheme podataka

Metapodaci odgovora

AnalyticsMeta · Shema · Sheme podataka: Analitika i pravila pretraživanja

periodAnalyticsPeriodData Obvezno: Razdoblje izvješća i njegove granice.

Primjer: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idNiz znakovaObvezno: Identifikator zahtjeva; u metapodacima odgovora označava HTTP zahtjev.

minLength: 1maxLength: 100

Primjer: "example"

Dodatna polja: Ne

Razdoblje izvješća i njegove granice

AnalyticsPeriodData · Shema · Sheme podataka: Analitika i pravila pretraživanja

as_ofNiz znakovaObvezno: Trenutak na koji se prikazani podaci odnose.

format: "date-time"

Primjer: "2026-01-02T00:00:00Z"
daysCijeli brojObvezno: Razdoblje izvješća u danima.

Primjer: 1
started_atNiz znakovaObvezno: Datum i vrijeme početka.

format: "date-time"

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

Dodatna polja: Ne

Popis · Upiti za pretraživanje — Analitika i pravila pretraživanja — Odgovor

AnalyticsResponse_list_MetricData__ · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

dataPolje vrijednosti <MetricData > Obvezno: Primjer odgovora · AnalyticsResponse_list_MetricData__.

Primjer: [{"clicks":1,"last_seen_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","searches":1,"zero_results":1}]
metaAnalyticsPageMeta AnalyticsMeta Obvezno: Metapodaci odgovora.

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

Dodatna polja: Ne

Dohvati · Upiti za pretraživanje — Analitika i pravila pretraživanja — Odgovor

AnalyticsResponse_list_OccurrenceData__ · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

dataPolje vrijednosti <OccurrenceData > Obvezno: Primjer odgovora · AnalyticsResponse_list_OccurrenceData__.

Primjer: [{"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 Obvezno: Metapodaci odgovora.

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

Dodatna polja: Ne

Sažetak — Analitika i pravila pretraživanja — Odgovor

AnalyticsResponse_OverviewData_ · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

dataOverviewData Obvezno: Primjer odgovora · OverviewData.

Primjer: {"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 Obvezno: Metapodaci odgovora.

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

Dodatna polja: Ne

Popis · Pravila — Analitika i pravila pretraživanja — Odgovor

ApiResponse_list_RuleSummaryData__ · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

dataPolje vrijednosti <RuleSummaryData > Obvezno: Primjer odgovora · ApiResponse_list_RuleSummaryData__.

Primjer: [{"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 Obvezno: Metapodaci odgovora.

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

Dodatna polja: Ne

Dohvati · Pravila — Analitika i pravila pretraživanja — Odgovor

ApiResponse_RuleDetailData_ · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

dataRuleDetailData Obvezno: Primjer odgovora · RuleDetailData.

Primjer: {"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 Obvezno: Metapodaci odgovora.

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

Dodatna polja: Ne

Popis · Upiti za pretraživanje — Analitika i pravila pretraživanja — Odgovor

MetricData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

clicksCijeli brojObvezno: Broj klikova.

Primjer: 1
last_seen_atNiz znakovaObvezno: Vrijeme posljednjeg pojavljivanja.

format: "date-time"

Primjer: "2026-01-01T12:00:00Z"
query_displayNiz znakovaObvezno: Izraz pretraživanja prikazan administratoru.

Primjer: "example"
query_hashNiz znakovaObvezno: Stabilan identifikator grupiranog izraza pretraživanja.

Primjer: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
searchesCijeli brojObvezno: Broj pretraživanja.

Primjer: 1
zero_resultsCijeli brojObvezno: Broj pretraživanja bez rezultata.

Primjer: 1

Dodatna polja: Ne

Dohvati · Upiti za pretraživanje — Analitika i pravila pretraživanja — Odgovor

OccurrenceData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

category_idNiz znakova nullObvezno

Identifikator kategorije.

Primjer: "example"

category_result_countCijeli brojObvezno

Broj rezultata kategorija.

Primjer: 1

currency_codeNiz znakovaObvezno

Kod valute.

Primjer: "PLN"

is_zero_resultsLogička vrijednostObvezno

Je li pretraživanje završilo bez rezultata.

Primjer: false

locale_codeNiz znakovaObvezno

Kod jezika.

Primjer: "en"

market_idNiz znakovaObvezno

Identifikator tržišta vraćen s krajnje točke konteksta.

Primjer: "example"

max_priceNiz znakova nullObvezno

Najviša cijena u navedenom rasponu.

Primjer: "0.00"

min_priceNiz znakova nullObvezno

Najniža cijena u navedenom rasponu.

Primjer: "0.00"

occurred_atNiz znakovaObvezno

Datum i vrijeme događaja.

format: "date-time"

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

pageCijeli brojObvezno

Podaci CMS stranice.

Primjer: 1

product_result_countCijeli brojObvezno

Broj rezultata pretraživanja proizvoda.

Primjer: 1

query_displayNiz znakovaObvezno

Izraz pretraživanja prikazan administratoru.

Primjer: "example"

request_idNiz znakovaObvezno

Identifikator zahtjeva; u metapodacima odgovora označava HTTP zahtjev.

Primjer: "example"

resultsPolje vrijednosti <ResultSnapshotData > nullObvezno

Zabilježeni rezultati pretraživanja.

Primjer:

[{"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_keyNiz znakovaObvezno

Ključ poretka.

Primjer: "example"

sourceNiz znakovaObvezno

Izvor zabilježene aktivnosti.

Ograničenja

enum: ["results", "autocomplete"]

Primjer: "results"

Dodatna polja: Ne

Sažetak — Analitika i pravila pretraživanja — Odgovor

OverviewData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

click_through_rateBrojObvezno: Stopa klikova za odabrane podatke pretraživanja.

Primjer: 0
clicked_searchesCijeli brojObvezno: Broj pretraživanja s klikom.

Primjer: 1
recentPolje vrijednosti <RecentSearchData > Obvezno: Podaci o nedavnim pretraživanjima.

Primjer: [{"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"}]
searchesCijeli brojObvezno: Broj pretraživanja.

Primjer: 1
zero_result_rateBrojObvezno: Udio pretraživanja bez rezultata.

Primjer: 0
zero_resultsCijeli brojObvezno: Broj pretraživanja bez rezultata.

Primjer: 1

Dodatna polja: Ne

Redoslijed sortiranja odabran za rezultate

QueryMetricSort · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

Niz znakova

Ograničenja

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

Dodatna polja: Da

Podaci o nedavnim pretraživanjima

RecentSearchData · Shema · Sheme podataka: Analitika i pravila pretraživanja

is_zero_resultsLogička vrijednostObvezno

Je li pretraživanje završilo bez rezultata.

Primjer: false

locale_codeNiz znakovaObvezno

Kod jezika.

Primjer: "en"

occurred_atNiz znakovaObvezno

Datum i vrijeme događaja.

format: "date-time"

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

query_displayNiz znakovaObvezno

Izraz pretraživanja prikazan administratoru.

Primjer: "example"

query_hashNiz znakovaObvezno

Stabilan identifikator grupiranog izraza pretraživanja.

Primjer: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idNiz znakovaObvezno

Identifikator zahtjeva; u metapodacima odgovora označava HTTP zahtjev.

Primjer: "example"

result_countCijeli brojObvezno

Broj rezultata pretraživanja.

Primjer: 1

sourceNiz znakovaObvezno

Izvor zabilježene aktivnosti.

Ograničenja

enum: ["results", "autocomplete"]

Primjer: "results"

Dodatna polja: Ne

Zabilježeni rezultati pretraživanja

ResultSnapshotData · Shema · Sheme podataka: Analitika i pravila pretraživanja

clickedLogička vrijednostObvezno

Je li rezultat kliknut.

Primjer: false

entity_idNiz znakovaObvezno

Identifikator entiteta na koji se upućuje.

Primjer: "example"

entity_typeNiz znakovaObvezno

Tip entiteta na koji se upućuje.

Ograničenja

enum: ["product", "category"]

Primjer: "product"

image_urlNiz znakova nullObvezno

URL slike.

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

numberNiz znakova nullObvezno

Broj narudžbe ili zahtjeva namijenjen korisniku.

Primjer: "example"

placement_sourceNiz znakovaObvezno

Izvor iz kojeg je narudžba poslana.

Ograničenja

enum: ["organic", "merchandising"]

Primjer: "organic"

positionCijeli brojObvezno

Položaj u uređenoj zbirci.

Primjer: 1

skuNiz znakovaObvezno

Šifra skladišne jedinice.

Primjer: "example"

slugNiz znakovaObvezno

Dio URL putanje na odabranom jeziku.

Primjer: "example"

titleNiz znakovaObvezno

Naslov na odabranom jeziku.

Primjer: "example"

Dodatna polja: Ne

Stvori · Pravila — Analitika i pravila pretraživanja — Tijelo zahtjeva

RuleCreate · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

category_idsPolje vrijednosti <Niz znakova> Neobavezno

Identifikatori povezanih kategorija.

maxItems: 100

Polje vrijednosti:minLength: 1maxLength: 63

enabledLogička vrijednostNeobavezno

Je li ova postavka uključena.

Zadano: false

market_idsPolje vrijednosti <Niz znakova> Neobavezno

Identifikatori odabranih tržišta.

maxItems: 1000

Polje vrijednosti:minLength: 1maxLength: 63

market_scopeNiz znakovaNeobavezno

Odnosi li se resurs na sva ili na odabrana tržišta.

Ograničenja

enum: ["all", "selected"]

nameNiz znakovaObvezno

Naziv resursa u odgovarajućem kontekstu.

minLength: 1maxLength: 160

Primjer: "Example"

phrasesPolje vrijednosti <Niz znakova> Obvezno

Izrazi koje koristi pravilo pretraživanja.

minItems: 1maxItems: 20

Polje vrijednosti:minLength: 1maxLength: 255

Primjer: ["example"]

product_idsPolje vrijednosti <Niz znakova> Neobavezno

Identifikatori povezanih proizvoda.

maxItems: 100

Polje vrijednosti:minLength: 1maxLength: 63

Primjer: ["example"]

Dodatna polja: Ne

Dohvati · Pravila — Analitika i pravila pretraživanja — Odgovor

RuleDetailData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

category_idsPolje vrijednosti <Niz znakova> Obvezno

Identifikatori povezanih kategorija.

Primjer: ["example"]

created_atNiz znakovaObvezno

Vrijeme izrade.

format: "date-time"

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

enabledLogička vrijednostObvezno

Je li ova postavka uključena.

Primjer: true

idNiz znakovaObvezno

Identifikator resursa; sačuvajte ga u vraćenom obliku. (RuleDetailData).

Primjer: "example"

is_availableLogička vrijednostObvezno

Je li stavka dostupna u ovom kontekstu.

Primjer: true

market_idsPolje vrijednosti <Niz znakova> Obvezno

Identifikatori odabranih tržišta.

Primjer: ["example"]

market_scopeNiz znakovaObvezno

Odnosi li se resurs na sva ili na odabrana tržišta.

Ograničenja

enum: ["all", "selected"]

Primjer: "all"

nameNiz znakovaObvezno

Naziv resursa u odgovarajućem kontekstu.

Primjer: "Example"

phrase_groupsPolje vrijednosti <RulePhraseGroupData > Obvezno

Grupe izraza pravila pretraživanja.

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

product_idsPolje vrijednosti <Niz znakova> Obvezno

Identifikatori povezanih proizvoda.

Primjer: ["example"]

updated_atNiz znakovaObvezno

Vrijeme posljednjeg ažuriranja.

format: "date-time"

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

versionCijeli brojObvezno

Verzija resursa za kontrolu istodobnih upisa.

Primjer: 1

Dodatna polja: Ne

Grupe izraza pravila pretraživanja

RulePhraseGroupData · Shema · Sheme podataka: Analitika i pravila pretraživanja

localeNiz znakovaObvezno: Jezik odabran za ovaj zahtjev.

Primjer: "en"
phrasesPolje vrijednosti <Niz znakova> Obvezno: Izrazi koje koristi pravilo pretraživanja.

Primjer: ["example"]

Dodatna polja: Ne

Popis · Pravila — Analitika i pravila pretraživanja — Odgovor

RuleSummaryData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

created_atNiz znakovaObvezno

Vrijeme izrade.

format: "date-time"

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

enabledLogička vrijednostObvezno

Je li ova postavka uključena.

Primjer: true

idNiz znakovaObvezno

Identifikator resursa; sačuvajte ga u vraćenom obliku. (RuleSummaryData).

Primjer: "example"

is_availableLogička vrijednostObvezno

Je li stavka dostupna u ovom kontekstu.

Primjer: true

market_scopeNiz znakovaObvezno

Odnosi li se resurs na sva ili na odabrana tržišta.

Ograničenja

enum: ["all", "selected"]

Primjer: "all"

nameNiz znakovaObvezno

Naziv resursa u odgovarajućem kontekstu.

Primjer: "Example"

updated_atNiz znakovaObvezno

Vrijeme posljednjeg ažuriranja.

format: "date-time"

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

versionCijeli brojObvezno

Verzija resursa za kontrolu istodobnih upisa.

Primjer: 1

Dodatna polja: Ne

Ažuriraj · Pravila — Analitika i pravila pretraživanja — Tijelo zahtjeva

RuleUpdate · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

category_idsPolje vrijednosti <Niz znakova> Neobavezno

Identifikatori povezanih kategorija.

maxItems: 100

Polje vrijednosti:minLength: 1maxLength: 63

enabledLogička vrijednostNeobavezno

Je li ova postavka uključena.

expected_versionCijeli brojObvezno

Verzija pročitana prije upisa; nepodudaranje odbija ažuriranje.

minimum: 1maximum: 2147483647

Primjer: 1

market_idsPolje vrijednosti <Niz znakova> Neobavezno

Identifikatori odabranih tržišta.

maxItems: 1000

Polje vrijednosti:minLength: 1maxLength: 63

market_scopeNiz znakovaNeobavezno

Odnosi li se resurs na sva ili na odabrana tržišta.

Ograničenja

enum: ["all", "selected"]

nameNiz znakovaNeobavezno

Naziv resursa u odgovarajućem kontekstu.

minLength: 1maxLength: 160

Primjer: "Example"

phrasesPolje vrijednosti <Niz znakova> Neobavezno

Izrazi koje koristi pravilo pretraživanja.

maxItems: 20

Polje vrijednosti:minLength: 1maxLength: 255

product_idsPolje vrijednosti <Niz znakova> Neobavezno

Identifikatori povezanih proizvoda.

maxItems: 100

Polje vrijednosti:minLength: 1maxLength: 63

Dodatna polja: Ne

Filtar za pretraživanja s pojavljivanjima bez rezultata ili bez takvih pojavljivanja

ZeroResultScope · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

Niz znakova

Ograničenja

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

Dodatna polja: Da