Podatkovne sheme: Analitika in pravila iskanja

Podatkovne sheme: Analitika in pravila iskanja. Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

Podatkovne sheme

Metapodatki odgovora

AnalyticsMeta · Shema · Podatkovne sheme: Analitika in pravila iskanja

periodAnalyticsPeriodData Obvezno: Obdobje poročanja in njegove meje.

Primer: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idNizObvezno: Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100

Primer: "example"

Dodatna polja: Ne

Obdobje poročanja in njegove meje

AnalyticsPeriodData · Shema · Podatkovne sheme: Analitika in pravila iskanja

as_ofNizObvezno: Čas, na katerega se nanašajo navedeni podatki.

format: "date-time"

Primer: "2026-01-02T00:00:00Z"
daysCelo številoObvezno: Obdobje poročanja v dnevih.

Primer: 1
started_atNizObvezno: Začetni datum in čas.

format: "date-time"

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

Dodatna polja: Ne

Prikaži seznam · Iskalne poizvedbe — Analitika in pravila iskanja — Odgovor

AnalyticsResponse_list_MetricData__ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

dataPolje elementov <MetricData > Obvezno: 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 Obvezno: Metapodatki 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

Pridobi · Iskalne poizvedbe — Analitika in pravila iskanja — Odgovor

AnalyticsResponse_list_OccurrenceData__ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

dataPolje elementov <OccurrenceData > Obvezno: 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 Obvezno: Metapodatki 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

Povzetek — Analitika in pravila iskanja — Odgovor

AnalyticsResponse_OverviewData_ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

dataOverviewData Obvezno: 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 Obvezno: Metapodatki 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 seznam · Pravila — Analitika in pravila iskanja — Odgovor

ApiResponse_list_RuleSummaryData__ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

dataPolje elementov <RuleSummaryData > Obvezno: 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 Obvezno: Metapodatki 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

Pridobi · Pravila — Analitika in pravila iskanja — Odgovor

ApiResponse_RuleDetailData_ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

dataRuleDetailData Obvezno: 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 Obvezno: Metapodatki odgovora.

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

Dodatna polja: Ne

Prikaži seznam · Iskalne poizvedbe — Analitika in pravila iskanja — Odgovor

MetricData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

clicksCelo številoObvezno: Število klikov.

Primer: 1
last_seen_atNizObvezno: Čas zadnje pojavitve.

format: "date-time"

Primer: "2026-01-01T12:00:00Z"
query_displayNizObvezno: Iskalni izraz, prikazan skrbniku.

Primer: "example"
query_hashNizObvezno: Stabilni identifikator združenega iskalnega izraza.

Primer: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
searchesCelo številoObvezno: Število iskanj.

Primer: 1
zero_resultsCelo številoObvezno: Število iskanj brez rezultatov.

Primer: 1

Dodatna polja: Ne

Pridobi · Iskalne poizvedbe — Analitika in pravila iskanja — Odgovor

OccurrenceData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

category_idNiz nullObvezno

Identifikator kategorije.

Primer: "example"

category_result_countCelo številoObvezno

Število rezultatov kategorij.

Primer: 1

currency_codeNizObvezno

Koda valute.

Primer: "PLN"

is_zero_resultsLogična vrednostObvezno

Ali iskanje ni vrnilo rezultatov.

Primer: false

locale_codeNizObvezno

Jezikovna koda.

Primer: "en"

market_idNizObvezno

Identifikator trga, vrnjen s končno točko konteksta.

Primer: "example"

max_priceNiz nullObvezno

Najvišja cena v navedenem razponu.

Primer: "0.00"

min_priceNiz nullObvezno

Najnižja cena v navedenem razponu.

Primer: "0.00"

occurred_atNizObvezno

Datum in čas dogodka.

format: "date-time"

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

pageCelo številoObvezno

Podatki strani CMS.

Primer: 1

product_result_countCelo številoObvezno

Število izdelkov v rezultatih iskanja.

Primer: 1

query_displayNizObvezno

Iskalni izraz, prikazan skrbniku.

Primer: "example"

request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

Primer: "example"

resultsPolje elementov <ResultSnapshotData > nullObvezno

Zabeleženi rezultati iskanja.

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_keyNizObvezno

Ključ razvrščanja.

Primer: "example"

sourceNizObvezno

Vir zabeležene dejavnosti.

Omejitve

enum: ["results", "autocomplete"]

Primer: "results"

Dodatna polja: Ne

Povzetek — Analitika in pravila iskanja — Odgovor

OverviewData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

click_through_rateŠteviloObvezno: Delež klikov za izbrane podatke iskanja.

Primer: 0
clicked_searchesCelo številoObvezno: Število iskanj s klikom.

Primer: 1
recentPolje elementov <RecentSearchData > Obvezno: Podatki o nedavnem iskanju.

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"}]
searchesCelo številoObvezno: Število iskanj.

Primer: 1
zero_result_rateŠteviloObvezno: Delež iskanj brez rezultatov.

Primer: 0
zero_resultsCelo številoObvezno: Število iskanj brez rezultatov.

Primer: 1

Dodatna polja: Ne

Izbrano razvrščanje rezultatov

QueryMetricSort · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

Niz

Omejitve

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

Dodatna polja: Da

Podatki o nedavnem iskanju

RecentSearchData · Shema · Podatkovne sheme: Analitika in pravila iskanja

is_zero_resultsLogična vrednostObvezno

Ali iskanje ni vrnilo rezultatov.

Primer: false

locale_codeNizObvezno

Jezikovna koda.

Primer: "en"

occurred_atNizObvezno

Datum in čas dogodka.

format: "date-time"

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

query_displayNizObvezno

Iskalni izraz, prikazan skrbniku.

Primer: "example"

query_hashNizObvezno

Stabilni identifikator združenega iskalnega izraza.

Primer: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

Primer: "example"

result_countCelo številoObvezno

Število rezultatov iskanja.

Primer: 1

sourceNizObvezno

Vir zabeležene dejavnosti.

Omejitve

enum: ["results", "autocomplete"]

Primer: "results"

Dodatna polja: Ne

Zabeleženi rezultati iskanja

ResultSnapshotData · Shema · Podatkovne sheme: Analitika in pravila iskanja

clickedLogična vrednostObvezno

Ali je bil rezultat kliknjen.

Primer: false

entity_idNizObvezno

Identifikator navedenega objekta.

Primer: "example"

entity_typeNizObvezno

Vrsta navedenega objekta.

Omejitve

enum: ["product", "category"]

Primer: "product"

image_urlNiz nullObvezno

URL slike.

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

numberNiz nullObvezno

Uporabniku prikazana številka naročila ali zahtevka.

Primer: "example"

placement_sourceNizObvezno

Vir, iz katerega je bilo oddano naročilo.

Omejitve

enum: ["organic", "merchandising"]

Primer: "organic"

positionCelo številoObvezno

Položaj v urejeni zbirki.

Primer: 1

skuNizObvezno

Koda enote za vodenje zaloge.

Primer: "example"

slugNizObvezno

Del poti URL v izbranem jeziku.

Primer: "example"

titleNizObvezno

Naslov v izbranem jeziku.

Primer: "example"

Dodatna polja: Ne

Ustvari · Pravila — Analitika in pravila iskanja — Telo zahteve

RuleCreate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

category_idsPolje elementov <Niz> Izbirno

Identifikatorji povezanih kategorij.

maxItems: 100

Polje elementov:minLength: 1maxLength: 63

enabledLogična vrednostIzbirno

Ali je nastavitev omogočena.

Privzeto: false

market_idsPolje elementov <Niz> Izbirno

Identifikatorji izbranih trgov.

maxItems: 1000

Polje elementov:minLength: 1maxLength: 63

market_scopeNizIzbirno

Ali vir velja za vse ali izbrane trge.

Omejitve

enum: ["all", "selected"]

nameNizObvezno

Ime vira v ustreznem kontekstu.

minLength: 1maxLength: 160

Primer: "Example"

phrasesPolje elementov <Niz> Obvezno

Izrazi, uporabljeni v pravilu iskanja.

minItems: 1maxItems: 20

Polje elementov:minLength: 1maxLength: 255

Primer: ["example"]

product_idsPolje elementov <Niz> Izbirno

Identifikatorji povezanih izdelkov.

maxItems: 100

Polje elementov:minLength: 1maxLength: 63

Primer: ["example"]

Dodatna polja: Ne

Pridobi · Pravila — Analitika in pravila iskanja — Odgovor

RuleDetailData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

category_idsPolje elementov <Niz> Obvezno

Identifikatorji povezanih kategorij.

Primer: ["example"]

created_atNizObvezno

Čas nastanka.

format: "date-time"

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

enabledLogična vrednostObvezno

Ali je nastavitev omogočena.

Primer: true

idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki. (RuleDetailData).

Primer: "example"

is_availableLogična vrednostObvezno

Ali je element na voljo v tem kontekstu.

Primer: true

market_idsPolje elementov <Niz> Obvezno

Identifikatorji izbranih trgov.

Primer: ["example"]

market_scopeNizObvezno

Ali vir velja za vse ali izbrane trge.

Omejitve

enum: ["all", "selected"]

Primer: "all"

nameNizObvezno

Ime vira v ustreznem kontekstu.

Primer: "Example"

phrase_groupsPolje elementov <RulePhraseGroupData > Obvezno

Skupine izrazov pravila iskanja.

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

product_idsPolje elementov <Niz> Obvezno

Identifikatorji povezanih izdelkov.

Primer: ["example"]

updated_atNizObvezno

Čas zadnje posodobitve.

format: "date-time"

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

versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

Primer: 1

Dodatna polja: Ne

Skupine izrazov pravila iskanja

RulePhraseGroupData · Shema · Podatkovne sheme: Analitika in pravila iskanja

localeNizObvezno: Jezik, izbran za to zahtevo.

Primer: "en"
phrasesPolje elementov <Niz> Obvezno: Izrazi, uporabljeni v pravilu iskanja.

Primer: ["example"]

Dodatna polja: Ne

Prikaži seznam · Pravila — Analitika in pravila iskanja — Odgovor

RuleSummaryData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

created_atNizObvezno

Čas nastanka.

format: "date-time"

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

enabledLogična vrednostObvezno

Ali je nastavitev omogočena.

Primer: true

idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki. (RuleSummaryData).

Primer: "example"

is_availableLogična vrednostObvezno

Ali je element na voljo v tem kontekstu.

Primer: true

market_scopeNizObvezno

Ali vir velja za vse ali izbrane trge.

Omejitve

enum: ["all", "selected"]

Primer: "all"

nameNizObvezno

Ime vira v ustreznem kontekstu.

Primer: "Example"

updated_atNizObvezno

Čas zadnje posodobitve.

format: "date-time"

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

versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

Primer: 1

Dodatna polja: Ne

Posodobi · Pravila — Analitika in pravila iskanja — Telo zahteve

RuleUpdate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

category_idsPolje elementov <Niz> Izbirno

Identifikatorji povezanih kategorij.

maxItems: 100

Polje elementov:minLength: 1maxLength: 63

enabledLogična vrednostIzbirno

Ali je nastavitev omogočena.

expected_versionCelo številoObvezno

Različica, prebrana pred zapisom; neujemanje zavrne posodobitev.

minimum: 1maximum: 2147483647

Primer: 1

market_idsPolje elementov <Niz> Izbirno

Identifikatorji izbranih trgov.

maxItems: 1000

Polje elementov:minLength: 1maxLength: 63

market_scopeNizIzbirno

Ali vir velja za vse ali izbrane trge.

Omejitve

enum: ["all", "selected"]

nameNizIzbirno

Ime vira v ustreznem kontekstu.

minLength: 1maxLength: 160

Primer: "Example"

phrasesPolje elementov <Niz> Izbirno

Izrazi, uporabljeni v pravilu iskanja.

maxItems: 20

Polje elementov:minLength: 1maxLength: 255

product_idsPolje elementov <Niz> Izbirno

Identifikatorji povezanih izdelkov.

maxItems: 100

Polje elementov:minLength: 1maxLength: 63

Dodatna polja: Ne

Filter za izbiro iskanj s pojavitvami brez rezultatov ali brez takih pojavitev

ZeroResultScope · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

Niz

Omejitve

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

Dodatna polja: Da