Andmeskeemid: Otsinguanalüüs ja reeglid

Andmeskeemid: Otsinguanalüüs ja reeglid. API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

Andmeskeemid

Vastuse metaandmed

AnalyticsMeta · Skeem · Andmeskeemid: Otsinguanalüüs ja reeglid

periodAnalyticsPeriodData Kohustuslik: Aruandeperiood ja selle piirid.

Näide: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idStringKohustuslik: Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100

Näide: "example"

Lisaväljad: Ei

Aruandeperiood ja selle piirid

AnalyticsPeriodData · Skeem · Andmeskeemid: Otsinguanalüüs ja reeglid

as_ofStringKohustuslik: Ajahetk, mille kohta esitatud andmed kehtivad.

format: "date-time"

Näide: "2026-01-02T00:00:00Z"
daysTäisarvKohustuslik: Aruandeperiood päevades.

Näide: 1
started_atStringKohustuslik: Alguskuupäev ja kellaaeg.

format: "date-time"

Näide: "2026-01-01T00:00:00Z"

Lisaväljad: Ei

Loend · Otsingupäringud — Otsinguanalüüs ja reeglid — Vastus

AnalyticsResponse_list_MetricData__ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

dataMassiiv <MetricData > Kohustuslik: Vastuse näide · AnalyticsResponse_list_MetricData__.

Näide: [{"clicks":1,"last_seen_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","searches":1,"zero_results":1}]
metaAnalyticsPageMeta AnalyticsMeta Kohustuslik: Vastuse metaandmed.

Näide: {"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"}

Lisaväljad: Ei

Hangi · Otsingupäringud — Otsinguanalüüs ja reeglid — Vastus

AnalyticsResponse_list_OccurrenceData__ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

dataMassiiv <OccurrenceData > Kohustuslik: Vastuse näide · AnalyticsResponse_list_OccurrenceData__.

Näide: [{"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 Kohustuslik: Vastuse metaandmed.

Näide: {"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"}

Lisaväljad: Ei

Kokkuvõte — Otsinguanalüüs ja reeglid — Vastus

AnalyticsResponse_OverviewData_ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

dataOverviewData Kohustuslik: Vastuse näide · OverviewData.

Näide: {"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 Kohustuslik: Vastuse metaandmed.

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

Lisaväljad: Ei

Loend · Reeglid — Otsinguanalüüs ja reeglid — Vastus

ApiResponse_list_RuleSummaryData__ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

dataMassiiv <RuleSummaryData > Kohustuslik: Vastuse näide · ApiResponse_list_RuleSummaryData__.

Näide: [{"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 Kohustuslik: Vastuse metaandmed.

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

Lisaväljad: Ei

Hangi · Reeglid — Otsinguanalüüs ja reeglid — Vastus

ApiResponse_RuleDetailData_ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

dataRuleDetailData Kohustuslik: Vastuse näide · RuleDetailData.

Näide: {"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 Kohustuslik: Vastuse metaandmed.

Näide: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Lisaväljad: Ei

Loend · Otsingupäringud — Otsinguanalüüs ja reeglid — Vastus

MetricData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

clicksTäisarvKohustuslik: Klikkide arv.

Näide: 1
last_seen_atStringKohustuslik: Viimase esinemise aeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"
query_displayStringKohustuslik: Administraatorile kuvatav otsingufraas.

Näide: "example"
query_hashStringKohustuslik: Rühmitatud otsingufraasi püsiv identifikaator.

Näide: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
searchesTäisarvKohustuslik: Otsingute arv.

Näide: 1
zero_resultsTäisarvKohustuslik: Tulemusteta otsingute arv.

Näide: 1

Lisaväljad: Ei

Hangi · Otsingupäringud — Otsinguanalüüs ja reeglid — Vastus

OccurrenceData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

category_idString nullKohustuslik

Kategooria identifikaator.

Näide: "example"

category_result_countTäisarvKohustuslik

Kategooriatulemuste arv.

Näide: 1

currency_codeStringKohustuslik

Valuutakood.

Näide: "PLN"

is_zero_resultsTõeväärtusKohustuslik

Kas otsing ei tagastanud tulemusi.

Näide: false

locale_codeStringKohustuslik

Keelekood.

Näide: "en"

market_idStringKohustuslik

Konteksti lõpp-punkti tagastatud turuidentifikaator.

Näide: "example"

max_priceString nullKohustuslik

Esitatud vahemiku kõrgeim hind.

Näide: "0.00"

min_priceString nullKohustuslik

Esitatud vahemiku madalaim hind.

Näide: "0.00"

occurred_atStringKohustuslik

Sündmuse kuupäev ja kellaaeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"

pageTäisarvKohustuslik

CMS-lehe teave.

Näide: 1

product_result_countTäisarvKohustuslik

Tooteotsingu tulemuste arv.

Näide: 1

query_displayStringKohustuslik

Administraatorile kuvatav otsingufraas.

Näide: "example"

request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

Näide: "example"

resultsMassiiv <ResultSnapshotData > nullKohustuslik

Salvestatud otsingutulemused.

Näide:

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

Järjestusvõti.

Näide: "example"

sourceStringKohustuslik

Salvestatud tegevuse allikas.

Piirangud

enum: ["results", "autocomplete"]

Näide: "results"

Lisaväljad: Ei

Kokkuvõte — Otsinguanalüüs ja reeglid — Vastus

OverviewData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

click_through_rateArvKohustuslik: Valitud otsinguandmete klikkimismäär.

Näide: 0
clicked_searchesTäisarvKohustuslik: Klikiga otsingute arv.

Näide: 1
recentMassiiv <RecentSearchData > Kohustuslik: Viimaste otsingute teave.

Näide: [{"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"}]
searchesTäisarvKohustuslik: Otsingute arv.

Näide: 1
zero_result_rateArvKohustuslik: Tulemusteta otsingute osakaal.

Näide: 0
zero_resultsTäisarvKohustuslik: Tulemusteta otsingute arv.

Näide: 1

Lisaväljad: Ei

Tulemustele valitud sortimisjärjestus

QueryMetricSort · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

String

Piirangud

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

Lisaväljad: Jah

Viimaste otsingute teave

RecentSearchData · Skeem · Andmeskeemid: Otsinguanalüüs ja reeglid

is_zero_resultsTõeväärtusKohustuslik

Kas otsing ei tagastanud tulemusi.

Näide: false

locale_codeStringKohustuslik

Keelekood.

Näide: "en"

occurred_atStringKohustuslik

Sündmuse kuupäev ja kellaaeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"

query_displayStringKohustuslik

Administraatorile kuvatav otsingufraas.

Näide: "example"

query_hashStringKohustuslik

Rühmitatud otsingufraasi püsiv identifikaator.

Näide: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

Näide: "example"

result_countTäisarvKohustuslik

Otsingutulemuste arv.

Näide: 1

sourceStringKohustuslik

Salvestatud tegevuse allikas.

Piirangud

enum: ["results", "autocomplete"]

Näide: "results"

Lisaväljad: Ei

Salvestatud otsingutulemused

ResultSnapshotData · Skeem · Andmeskeemid: Otsinguanalüüs ja reeglid

clickedTõeväärtusKohustuslik

Kas tulemusel klikiti.

Näide: false

entity_idStringKohustuslik

Viidatud üksuse identifikaator.

Näide: "example"

entity_typeStringKohustuslik

Viidatud üksuse tüüp.

Piirangud

enum: ["product", "category"]

Näide: "product"

image_urlString nullKohustuslik

Pildi URL.

Näide: "https://example.invalid/product.jpg"

numberString nullKohustuslik

Kasutajale mõeldud tellimuse või pöördumise number.

Näide: "example"

placement_sourceStringKohustuslik

Kanal, kust tellimus esitati.

Piirangud

enum: ["organic", "merchandising"]

Näide: "organic"

positionTäisarvKohustuslik

Asukoht järjestatud kogumis.

Näide: 1

skuStringKohustuslik

Laoarvestusühiku kood.

Näide: "example"

slugStringKohustuslik

URL-i teesegment valitud keeles.

Näide: "example"

titleStringKohustuslik

Pealkiri valitud keeles.

Näide: "example"

Lisaväljad: Ei

Loo · Reeglid — Otsinguanalüüs ja reeglid — Päringu sisu

RuleCreate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

category_idsMassiiv <String> Valikuline

Seotud kategooriate identifikaatorid.

maxItems: 100

Massiiv:minLength: 1maxLength: 63

enabledTõeväärtusValikuline

Kas see säte on lubatud.

Vaikeväärtus: false

market_idsMassiiv <String> Valikuline

Valitud turgude identifikaatorid.

maxItems: 1000

Massiiv:minLength: 1maxLength: 63

market_scopeStringValikuline

Kas ressurss hõlmab kõiki või valitud turge.

Piirangud

enum: ["all", "selected"]

nameStringKohustuslik

Ressursi nimi vastavas kontekstis.

minLength: 1maxLength: 160

Näide: "Example"

phrasesMassiiv <String> Kohustuslik

Otsingureeglis kasutatavad fraasid.

minItems: 1maxItems: 20

Massiiv:minLength: 1maxLength: 255

Näide: ["example"]

product_idsMassiiv <String> Valikuline

Seotud toodete identifikaatorid.

maxItems: 100

Massiiv:minLength: 1maxLength: 63

Näide: ["example"]

Lisaväljad: Ei

Hangi · Reeglid — Otsinguanalüüs ja reeglid — Vastus

RuleDetailData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

category_idsMassiiv <String> Kohustuslik

Seotud kategooriate identifikaatorid.

Näide: ["example"]

created_atStringKohustuslik

Loomise aeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"

enabledTõeväärtusKohustuslik

Kas see säte on lubatud.

Näide: true

idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul. (RuleDetailData).

Näide: "example"

is_availableTõeväärtusKohustuslik

Kas kirje on selles kontekstis saadaval.

Näide: true

market_idsMassiiv <String> Kohustuslik

Valitud turgude identifikaatorid.

Näide: ["example"]

market_scopeStringKohustuslik

Kas ressurss hõlmab kõiki või valitud turge.

Piirangud

enum: ["all", "selected"]

Näide: "all"

nameStringKohustuslik

Ressursi nimi vastavas kontekstis.

Näide: "Example"

phrase_groupsMassiiv <RulePhraseGroupData > Kohustuslik

Otsingureegli fraasirühmad.

Näide: [{"locale":"en","phrases":["example"]}]

product_idsMassiiv <String> Kohustuslik

Seotud toodete identifikaatorid.

Näide: ["example"]

updated_atStringKohustuslik

Viimase uuendamise aeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"

versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 1

Lisaväljad: Ei

Otsingureegli fraasirühmad

RulePhraseGroupData · Skeem · Andmeskeemid: Otsinguanalüüs ja reeglid

localeStringKohustuslik: Selle päringu jaoks valitud keel.

Näide: "en"
phrasesMassiiv <String> Kohustuslik: Otsingureeglis kasutatavad fraasid.

Näide: ["example"]

Lisaväljad: Ei

Loend · Reeglid — Otsinguanalüüs ja reeglid — Vastus

RuleSummaryData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

created_atStringKohustuslik

Loomise aeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"

enabledTõeväärtusKohustuslik

Kas see säte on lubatud.

Näide: true

idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul. (RuleSummaryData).

Näide: "example"

is_availableTõeväärtusKohustuslik

Kas kirje on selles kontekstis saadaval.

Näide: true

market_scopeStringKohustuslik

Kas ressurss hõlmab kõiki või valitud turge.

Piirangud

enum: ["all", "selected"]

Näide: "all"

nameStringKohustuslik

Ressursi nimi vastavas kontekstis.

Näide: "Example"

updated_atStringKohustuslik

Viimase uuendamise aeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"

versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 1

Lisaväljad: Ei

Muuda · Reeglid — Otsinguanalüüs ja reeglid — Päringu sisu

RuleUpdate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

category_idsMassiiv <String> Valikuline

Seotud kategooriate identifikaatorid.

maxItems: 100

Massiiv:minLength: 1maxLength: 63

enabledTõeväärtusValikuline

Kas see säte on lubatud.

expected_versionTäisarvKohustuslik

Enne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.

minimum: 1maximum: 2147483647

Näide: 1

market_idsMassiiv <String> Valikuline

Valitud turgude identifikaatorid.

maxItems: 1000

Massiiv:minLength: 1maxLength: 63

market_scopeStringValikuline

Kas ressurss hõlmab kõiki või valitud turge.

Piirangud

enum: ["all", "selected"]

nameStringValikuline

Ressursi nimi vastavas kontekstis.

minLength: 1maxLength: 160

Näide: "Example"

phrasesMassiiv <String> Valikuline

Otsingureeglis kasutatavad fraasid.

maxItems: 20

Massiiv:minLength: 1maxLength: 255

product_idsMassiiv <String> Valikuline

Seotud toodete identifikaatorid.

maxItems: 100

Massiiv:minLength: 1maxLength: 63

Lisaväljad: Ei

Filter, mis valib otsingud tulemusteta esinemistega või ilma nendeta

ZeroResultScope · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

String

Piirangud

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

Lisaväljad: Jah