Pređi na sadržaj
ShopentlyLearn

Šeme podataka: Analitika i pravila pretraživanja

Šeme podataka: Analitika i pravila pretraživanja. Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.

Šeme podataka

Metapodaci odgovora

AnalyticsMeta · Šema · Šeme podataka: Analitika i pravila pretraživanja
periodAnalyticsPeriodData Obavezno

Period izveštaja i njegove granice.

Primer: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idNiz znakovaObavezno

Identifikator zahteva; u metapodacima odgovora označava HTTP zahtev.

minLength: 1maxLength: 100
Primer: "example"

Dodatna polja: Ne

Period izveštaja i njegove granice

AnalyticsPeriodData · Šema · Šeme podataka: Analitika i pravila pretraživanja
as_ofNiz znakovaObavezno

Trenutak na koji se prikazani podaci odnose.

format: "date-time"
Primer: "2026-01-02T00:00:00Z"
daysCeli brojObavezno

Period izveštaja u danima.

Primer: 1
started_atNiz znakovaObavezno

Datum i vreme početka.

format: "date-time"
Primer: "2026-01-01T00:00:00Z"

Dodatna polja: Ne

Prikaži listu · Upiti za pretragu — Analitika i pravila pretraživanja — Odgovor

AnalyticsResponse_list_MetricData__ · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
dataNiz vrednosti <MetricData > Obavezno

Primer odgovora · AnalyticsResponse_list_MetricData__.

Primer: [{"clicks":1,"last_seen_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","searches":1,"zero_results":1}]
metaAnalyticsPageMeta AnalyticsMeta Obavezno

Metapodaci odgovora.

Primer: {"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

Preuzmi · Upiti za pretragu — Analitika i pravila pretraživanja — Odgovor

AnalyticsResponse_list_OccurrenceData__ · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
dataNiz vrednosti <OccurrenceData > Obavezno

Primer odgovora · AnalyticsResponse_list_OccurrenceData__.

Primer: [{"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 Obavezno

Metapodaci odgovora.

Primer: {"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, tipovi i ograničenja podataka koje API prihvata ili vraća.
dataOverviewData Obavezno

Primer odgovora · OverviewData.

Primer: {"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 Obavezno

Metapodaci odgovora.

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

Dodatna polja: Ne

Prikaži listu · Pravila — Analitika i pravila pretraživanja — Odgovor

ApiResponse_list_RuleSummaryData__ · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
dataNiz vrednosti <RuleSummaryData > Obavezno

Primer odgovora · ApiResponse_list_RuleSummaryData__.

Primer: [{"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 Obavezno

Metapodaci odgovora.

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

Dodatna polja: Ne

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

ApiResponse_RuleDetailData_ · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
dataRuleDetailData Obavezno

Primer odgovora · RuleDetailData.

Primer: {"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 Obavezno

Metapodaci odgovora.

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

Dodatna polja: Ne

Prikaži listu · Upiti za pretragu — Analitika i pravila pretraživanja — Odgovor

MetricData · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
clicksCeli brojObavezno

Broj klikova.

Primer: 1
last_seen_atNiz znakovaObavezno

Vreme poslednjeg pojavljivanja.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
query_displayNiz znakovaObavezno

Izraz pretraživanja prikazan administratoru.

Primer: "example"
query_hashNiz znakovaObavezno

Stabilan identifikator grupiranog izraza pretraživanja.

Primer: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
searchesCeli brojObavezno

Broj pretraživanja.

Primer: 1
zero_resultsCeli brojObavezno

Broj pretraživanja bez rezultata.

Primer: 1

Dodatna polja: Ne

Preuzmi · Upiti za pretragu — Analitika i pravila pretraživanja — Odgovor

OccurrenceData · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
category_idNiz znakova nullObavezno

Identifikator kategorije.

Primer: "example"
category_result_countCeli brojObavezno

Broj rezultata kategorija.

Primer: 1
currency_codeNiz znakovaObavezno

Kod valute.

Primer: "PLN"
is_zero_resultsLogička vrednostObavezno

Da li je pretraživanje završilo bez rezultata.

Primer: false
locale_codeNiz znakovaObavezno

Kod jezika.

Primer: "en"
market_idNiz znakovaObavezno

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

Primer: "example"
max_priceNiz znakova nullObavezno

Najviša cena u navedenom rasponu.

Primer: "0.00"
min_priceNiz znakova nullObavezno

Najniža cena u navedenom rasponu.

Primer: "0.00"
occurred_atNiz znakovaObavezno

Datum i vreme događaja.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
pageCeli brojObavezno

Podaci CMS stranice.

Primer: 1
product_result_countCeli brojObavezno

Broj rezultata pretraživanja proizvoda.

Primer: 1
query_displayNiz znakovaObavezno

Izraz pretraživanja prikazan administratoru.

Primer: "example"
request_idNiz znakovaObavezno

Identifikator zahteva; u metapodacima odgovora označava HTTP zahtev.

Primer: "example"
resultsNiz vrednosti <ResultSnapshotData > nullObavezno

Zabeleženi rezultati pretraživanja.

Primer: [{"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 znakovaObavezno

Ključ poretka.

Primer: "example"
sourceNiz znakovaObavezno

Izvor zabeležene aktivnosti.

Ograničenja
enum
["results", "autocomplete"]
Primer: "results"

Dodatna polja: Ne

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

OverviewData · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
click_through_rateBrojObavezno

Stopa klikova za odabrane podatke pretraživanja.

Primer: 0
clicked_searchesCeli brojObavezno

Broj pretraživanja s klikom.

Primer: 1
recentNiz vrednosti <RecentSearchData > Obavezno

Podaci o nedavnim pretraživanjima.

Primer: [{"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"}]
searchesCeli brojObavezno

Broj pretraživanja.

Primer: 1
zero_result_rateBrojObavezno

Udeo pretraživanja bez rezultata.

Primer: 0
zero_resultsCeli brojObavezno

Broj pretraživanja bez rezultata.

Primer: 1

Dodatna polja: Ne

Redosled sortiranja odabran za rezultate

QueryMetricSort · Polja, tipovi i ograničenja podataka koje API prihvata 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 · Šema · Šeme podataka: Analitika i pravila pretraživanja
is_zero_resultsLogička vrednostObavezno

Da li je pretraživanje završilo bez rezultata.

Primer: false
locale_codeNiz znakovaObavezno

Kod jezika.

Primer: "en"
occurred_atNiz znakovaObavezno

Datum i vreme događaja.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
query_displayNiz znakovaObavezno

Izraz pretraživanja prikazan administratoru.

Primer: "example"
query_hashNiz znakovaObavezno

Stabilan identifikator grupiranog izraza pretraživanja.

Primer: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
request_idNiz znakovaObavezno

Identifikator zahteva; u metapodacima odgovora označava HTTP zahtev.

Primer: "example"
result_countCeli brojObavezno

Broj rezultata pretraživanja.

Primer: 1
sourceNiz znakovaObavezno

Izvor zabeležene aktivnosti.

Ograničenja
enum
["results", "autocomplete"]
Primer: "results"

Dodatna polja: Ne

Zabeleženi rezultati pretraživanja

ResultSnapshotData · Šema · Šeme podataka: Analitika i pravila pretraživanja
clickedLogička vrednostObavezno

Da li je rezultat kliknut.

Primer: false
entity_idNiz znakovaObavezno

Identifikator entiteta na koji se upućuje.

Primer: "example"
entity_typeNiz znakovaObavezno

Tip entiteta na koji se upućuje.

Ograničenja
enum
["product", "category"]
Primer: "product"
image_urlNiz znakova nullObavezno

URL slike.

Primer: "https://example.invalid/product.jpg"
numberNiz znakova nullObavezno

Broj porudžbine ili zahteva namenjen korisniku.

Primer: "example"
placement_sourceNiz znakovaObavezno

Izvor iz kojeg je porudžbina poslana.

Ograničenja
enum
["organic", "merchandising"]
Primer: "organic"
positionCeli brojObavezno

Položaj u uređenoj kolekciji.

Primer: 1
skuNiz znakovaObavezno

Šifra skladišne jedinice.

Primer: "example"
slugNiz znakovaObavezno

Deo URL putanje na odabranom jeziku.

Primer: "example"
titleNiz znakovaObavezno

Naslov na odabranom jeziku.

Primer: "example"

Dodatna polja: Ne

Kreiraj · Pravila — Analitika i pravila pretraživanja — Telo zahteva

RuleCreate · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
category_idsNiz vrednosti <Niz znakova> Opciono

Identifikatori povezanih kategorija.

maxItems: 100
Niz vrednosti:minLength: 1maxLength: 63
enabledLogička vrednostOpciono

Da li je ova postavka uključena.

Podrazumevano: false
market_idsNiz vrednosti <Niz znakova> Opciono

Identifikatori odabranih tržišta.

maxItems: 1000
Niz vrednosti:minLength: 1maxLength: 63
market_scopeNiz znakovaOpciono

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

Ograničenja
enum
["all", "selected"]
nameNiz znakovaObavezno

Naziv resursa u odgovarajućem kontekstu.

minLength: 1maxLength: 160
Primer: "Example"
phrasesNiz vrednosti <Niz znakova> Obavezno

Izrazi koje koristi pravilo pretraživanja.

minItems: 1maxItems: 20
Niz vrednosti:minLength: 1maxLength: 255
Primer: ["example"]
product_idsNiz vrednosti <Niz znakova> Opciono

Identifikatori povezanih proizvoda.

maxItems: 100
Niz vrednosti:minLength: 1maxLength: 63
Primer: ["example"]

Dodatna polja: Ne

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

RuleDetailData · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
category_idsNiz vrednosti <Niz znakova> Obavezno

Identifikatori povezanih kategorija.

Primer: ["example"]
created_atNiz znakovaObavezno

Vreme kreiranja.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
enabledLogička vrednostObavezno

Da li je ova postavka uključena.

Primer: true
idNiz znakovaObavezno

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

Primer: "example"
is_availableLogička vrednostObavezno

Da li je stavka dostupna u ovom kontekstu.

Primer: true
market_idsNiz vrednosti <Niz znakova> Obavezno

Identifikatori odabranih tržišta.

Primer: ["example"]
market_scopeNiz znakovaObavezno

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

Ograničenja
enum
["all", "selected"]
Primer: "all"
nameNiz znakovaObavezno

Naziv resursa u odgovarajućem kontekstu.

Primer: "Example"
phrase_groupsNiz vrednosti <RulePhraseGroupData > Obavezno

Grupe izraza pravila pretraživanja.

Primer: [{"locale":"en","phrases":["example"]}]
product_idsNiz vrednosti <Niz znakova> Obavezno

Identifikatori povezanih proizvoda.

Primer: ["example"]
updated_atNiz znakovaObavezno

Vreme poslednjeg ažuriranja.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
versionCeli brojObavezno

Verzija resursa za kontrolu istovremenih upisa.

Primer: 1

Dodatna polja: Ne

Grupe izraza pravila pretraživanja

RulePhraseGroupData · Šema · Šeme podataka: Analitika i pravila pretraživanja
localeNiz znakovaObavezno

Jezik odabran za ovaj zahtev.

Primer: "en"
phrasesNiz vrednosti <Niz znakova> Obavezno

Izrazi koje koristi pravilo pretraživanja.

Primer: ["example"]

Dodatna polja: Ne

Prikaži listu · Pravila — Analitika i pravila pretraživanja — Odgovor

RuleSummaryData · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
created_atNiz znakovaObavezno

Vreme kreiranja.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
enabledLogička vrednostObavezno

Da li je ova postavka uključena.

Primer: true
idNiz znakovaObavezno

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

Primer: "example"
is_availableLogička vrednostObavezno

Da li je stavka dostupna u ovom kontekstu.

Primer: true
market_scopeNiz znakovaObavezno

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

Ograničenja
enum
["all", "selected"]
Primer: "all"
nameNiz znakovaObavezno

Naziv resursa u odgovarajućem kontekstu.

Primer: "Example"
updated_atNiz znakovaObavezno

Vreme poslednjeg ažuriranja.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
versionCeli brojObavezno

Verzija resursa za kontrolu istovremenih upisa.

Primer: 1

Dodatna polja: Ne

Ažuriraj · Pravila — Analitika i pravila pretraživanja — Telo zahteva

RuleUpdate · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
category_idsNiz vrednosti <Niz znakova> Opciono

Identifikatori povezanih kategorija.

maxItems: 100
Niz vrednosti:minLength: 1maxLength: 63
enabledLogička vrednostOpciono

Da li je ova postavka uključena.

expected_versionCeli brojObavezno

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

minimum: 1maximum: 2147483647
Primer: 1
market_idsNiz vrednosti <Niz znakova> Opciono

Identifikatori odabranih tržišta.

maxItems: 1000
Niz vrednosti:minLength: 1maxLength: 63
market_scopeNiz znakovaOpciono

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

Ograničenja
enum
["all", "selected"]
nameNiz znakovaOpciono

Naziv resursa u odgovarajućem kontekstu.

minLength: 1maxLength: 160
Primer: "Example"
phrasesNiz vrednosti <Niz znakova> Opciono

Izrazi koje koristi pravilo pretraživanja.

maxItems: 20
Niz vrednosti:minLength: 1maxLength: 255
product_idsNiz vrednosti <Niz znakova> Opciono

Identifikatori povezanih proizvoda.

maxItems: 100
Niz vrednosti:minLength: 1maxLength: 63

Dodatna polja: Ne

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

ZeroResultScope · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
Niz znakova
Ograničenja
enum
["all", "has_zero_results", "no_zero_results"]

Dodatna polja: Da