Datu shēmas: Meklēšanas analītika un noteikumi

Datu shēmas: Meklēšanas analītika un noteikumi. API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

Datu shēmas

Atbildes metadati

AnalyticsMeta · Shēma · Datu shēmas: Meklēšanas analītika un noteikumi

periodAnalyticsPeriodData Obligāts: Pārskata periods un tā robežas.

Piemērs: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idVirkneObligāts: Pieteikuma identifikators; atbildes metadatos tas identificē HTTP pieprasījumu.

minLength: 1maxLength: 100

Piemērs: "example"

Papildu lauki: Nē

Pārskata periods un tā robežas

AnalyticsPeriodData · Shēma · Datu shēmas: Meklēšanas analītika un noteikumi

as_ofVirkneObligāts: Laiks, uz kuru attiecas norādītie dati.

format: "date-time"

Piemērs: "2026-01-02T00:00:00Z"
daysVesels skaitlisObligāts: Pārskata periods dienās.

Piemērs: 1
started_atVirkneObligāts: Sākuma datums un laiks.

format: "date-time"

Piemērs: "2026-01-01T00:00:00Z"

Papildu lauki: Nē

Saraksts · Meklēšanas vaicājumi — Meklēšanas analītika un noteikumi — Atbilde

AnalyticsResponse_list_MetricData__ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

dataMasīvs <MetricData > Obligāts: Atbildes piemērs · AnalyticsResponse_list_MetricData__.

Piemērs: [{"clicks":1,"last_seen_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","searches":1,"zero_results":1}]
metaAnalyticsPageMeta AnalyticsMeta Obligāts: Atbildes metadati.

Piemērs: {"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"}

Papildu lauki: Nē

Iegūt · Meklēšanas vaicājumi — Meklēšanas analītika un noteikumi — Atbilde

AnalyticsResponse_list_OccurrenceData__ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

dataMasīvs <OccurrenceData > Obligāts: Atbildes piemērs · AnalyticsResponse_list_OccurrenceData__.

Piemērs: [{"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 Obligāts: Atbildes metadati.

Piemērs: {"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"}

Papildu lauki: Nē

Kopsavilkums — Meklēšanas analītika un noteikumi — Atbilde

AnalyticsResponse_OverviewData_ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

dataOverviewData Obligāts: Atbildes piemērs · OverviewData.

Piemērs: {"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 Obligāts: Atbildes metadati.

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

Papildu lauki: Nē

Saraksts · Noteikumi — Meklēšanas analītika un noteikumi — Atbilde

ApiResponse_list_RuleSummaryData__ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

dataMasīvs <RuleSummaryData > Obligāts: Atbildes piemērs · ApiResponse_list_RuleSummaryData__.

Piemērs: [{"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 Obligāts: Atbildes metadati.

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

Papildu lauki: Nē

Iegūt · Noteikumi — Meklēšanas analītika un noteikumi — Atbilde

ApiResponse_RuleDetailData_ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

dataRuleDetailData Obligāts: Atbildes piemērs · RuleDetailData.

Piemērs: {"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 Obligāts: Atbildes metadati.

Piemērs: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Papildu lauki: Nē

Saraksts · Meklēšanas vaicājumi — Meklēšanas analītika un noteikumi — Atbilde

MetricData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

clicksVesels skaitlisObligāts: Klikšķu skaits.

Piemērs: 1
last_seen_atVirkneObligāts: Pēdējās reizes laiks.

format: "date-time"

Piemērs: "2026-01-01T12:00:00Z"
query_displayVirkneObligāts: Administratoram parādītā meklēšanas frāze.

Piemērs: "example"
query_hashVirkneObligāts: Grupētās meklēšanas frāzes stabils identifikators.

Piemērs: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
searchesVesels skaitlisObligāts: Meklējumu skaits.

Piemērs: 1
zero_resultsVesels skaitlisObligāts: Meklējumu bez rezultātiem skaits.

Piemērs: 1

Papildu lauki: Nē

Iegūt · Meklēšanas vaicājumi — Meklēšanas analītika un noteikumi — Atbilde

OccurrenceData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

category_idVirkne nullObligāts

Kategorijas identifikators.

Piemērs: "example"

category_result_countVesels skaitlisObligāts

Kategoriju rezultātu skaits.

Piemērs: 1

currency_codeVirkneObligāts

Valūtas kods.

Piemērs: "PLN"

is_zero_resultsLoģiska vērtībaObligāts

Vai meklēšana neatgrieza rezultātus.

Piemērs: false

locale_codeVirkneObligāts

Valodas kods.

Piemērs: "en"

market_idVirkneObligāts

Konteksta galapunkta atgrieztais tirgus identifikators.

Piemērs: "example"

max_priceVirkne nullObligāts

Augstākā cena norādītajā diapazonā.

Piemērs: "0.00"

min_priceVirkne nullObligāts

Zemākā cena norādītajā diapazonā.

Piemērs: "0.00"

occurred_atVirkneObligāts

Notikuma datums un laiks.

format: "date-time"

Piemērs: "2026-01-01T12:00:00Z"

pageVesels skaitlisObligāts

CMS lapas informācija.

Piemērs: 1

product_result_countVesels skaitlisObligāts

Produktu meklēšanas rezultātu skaits.

Piemērs: 1

query_displayVirkneObligāts

Administratoram parādītā meklēšanas frāze.

Piemērs: "example"

request_idVirkneObligāts

Pieteikuma identifikators; atbildes metadatos tas identificē HTTP pieprasījumu.

Piemērs: "example"

resultsMasīvs <ResultSnapshotData > nullObligāts

Reģistrētie meklēšanas rezultāti.

Piemērs:

[{"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_keyVirkneObligāts

Kārtošanas atslēga.

Piemērs: "example"

sourceVirkneObligāts

Reģistrētās aktivitātes avots.

Ierobežojumi

enum: ["results", "autocomplete"]

Piemērs: "results"

Papildu lauki: Nē

Kopsavilkums — Meklēšanas analītika un noteikumi — Atbilde

OverviewData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

click_through_rateSkaitlisObligāts: Izvēlēto meklēšanas datu klikšķu īpatsvars.

Piemērs: 0
clicked_searchesVesels skaitlisObligāts: Meklējumu skaits ar klikšķi.

Piemērs: 1
recentMasīvs <RecentSearchData > Obligāts: Nesenās meklēšanas informācija.

Piemērs: [{"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"}]
searchesVesels skaitlisObligāts: Meklējumu skaits.

Piemērs: 1
zero_result_rateSkaitlisObligāts: Meklējumu bez rezultātiem īpatsvars.

Piemērs: 0
zero_resultsVesels skaitlisObligāts: Meklējumu bez rezultātiem skaits.

Piemērs: 1

Papildu lauki: Nē

Rezultātiem izvēlētā kārtošanas secība

QueryMetricSort · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

Virkne

Ierobežojumi

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

Papildu lauki: Jā

Nesenās meklēšanas informācija

RecentSearchData · Shēma · Datu shēmas: Meklēšanas analītika un noteikumi

is_zero_resultsLoģiska vērtībaObligāts

Vai meklēšana neatgrieza rezultātus.

Piemērs: false

locale_codeVirkneObligāts

Valodas kods.

Piemērs: "en"

occurred_atVirkneObligāts

Notikuma datums un laiks.

format: "date-time"

Piemērs: "2026-01-01T12:00:00Z"

query_displayVirkneObligāts

Administratoram parādītā meklēšanas frāze.

Piemērs: "example"

query_hashVirkneObligāts

Grupētās meklēšanas frāzes stabils identifikators.

Piemērs: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idVirkneObligāts

Pieteikuma identifikators; atbildes metadatos tas identificē HTTP pieprasījumu.

Piemērs: "example"

result_countVesels skaitlisObligāts

Meklēšanas rezultātu skaits.

Piemērs: 1

sourceVirkneObligāts

Reģistrētās aktivitātes avots.

Ierobežojumi

enum: ["results", "autocomplete"]

Piemērs: "results"

Papildu lauki: Nē

Reģistrētie meklēšanas rezultāti

ResultSnapshotData · Shēma · Datu shēmas: Meklēšanas analītika un noteikumi

clickedLoģiska vērtībaObligāts

Vai uz rezultāta noklikšķināts.

Piemērs: false

entity_idVirkneObligāts

Norādītās entītijas identifikators.

Piemērs: "example"

entity_typeVirkneObligāts

Norādītās entītijas tips.

Ierobežojumi

enum: ["product", "category"]

Piemērs: "product"

image_urlVirkne nullObligāts

Attēla URL.

Piemērs: "https://example.invalid/product.jpg"

numberVirkne nullObligāts

Lietotājam paredzēts pasūtījuma vai pieteikuma numurs.

Piemērs: "example"

placement_sourceVirkneObligāts

Avots, no kura veikts pasūtījums.

Ierobežojumi

enum: ["organic", "merchandising"]

Piemērs: "organic"

positionVesels skaitlisObligāts

Pozīcija sakārtotā kolekcijā.

Piemērs: 1

skuVirkneObligāts

Krājumu uzskaites vienības kods.

Piemērs: "example"

slugVirkneObligāts

URL ceļa segments izvēlētajā valodā.

Piemērs: "example"

titleVirkneObligāts

Virsraksts izvēlētajā valodā.

Piemērs: "example"

Papildu lauki: Nē

Izveidot · Noteikumi — Meklēšanas analītika un noteikumi — Pieprasījuma saturs

RuleCreate · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

category_idsMasīvs <Virkne> Neobligāts

Saistīto kategoriju identifikatori.

maxItems: 100

Masīvs:minLength: 1maxLength: 63

enabledLoģiska vērtībaNeobligāts

Vai šis iestatījums ir ieslēgts.

Noklusējums: false

market_idsMasīvs <Virkne> Neobligāts

Izvēlēto tirgu identifikatori.

maxItems: 1000

Masīvs:minLength: 1maxLength: 63

market_scopeVirkneNeobligāts

Vai resurss attiecas uz visiem vai izvēlētiem tirgiem.

Ierobežojumi

enum: ["all", "selected"]

nameVirkneObligāts

Resursa nosaukums attiecīgajā kontekstā.

minLength: 1maxLength: 160

Piemērs: "Example"

phrasesMasīvs <Virkne> Obligāts

Meklēšanas noteikumā izmantotās frāzes.

minItems: 1maxItems: 20

Masīvs:minLength: 1maxLength: 255

Piemērs: ["example"]

product_idsMasīvs <Virkne> Neobligāts

Saistīto produktu identifikatori.

maxItems: 100

Masīvs:minLength: 1maxLength: 63

Piemērs: ["example"]

Papildu lauki: Nē

Iegūt · Noteikumi — Meklēšanas analītika un noteikumi — Atbilde

RuleDetailData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

category_idsMasīvs <Virkne> Obligāts

Saistīto kategoriju identifikatori.

Piemērs: ["example"]

created_atVirkneObligāts

Izveides laiks.

format: "date-time"

Piemērs: "2026-01-01T12:00:00Z"

enabledLoģiska vērtībaObligāts

Vai šis iestatījums ir ieslēgts.

Piemērs: true

idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā. (RuleDetailData).

Piemērs: "example"

is_availableLoģiska vērtībaObligāts

Vai vienums ir pieejams šajā kontekstā.

Piemērs: true

market_idsMasīvs <Virkne> Obligāts

Izvēlēto tirgu identifikatori.

Piemērs: ["example"]

market_scopeVirkneObligāts

Vai resurss attiecas uz visiem vai izvēlētiem tirgiem.

Ierobežojumi

enum: ["all", "selected"]

Piemērs: "all"

nameVirkneObligāts

Resursa nosaukums attiecīgajā kontekstā.

Piemērs: "Example"

phrase_groupsMasīvs <RulePhraseGroupData > Obligāts

Meklēšanas noteikuma frāžu grupas.

Piemērs: [{"locale":"en","phrases":["example"]}]

product_idsMasīvs <Virkne> Obligāts

Saistīto produktu identifikatori.

Piemērs: ["example"]

updated_atVirkneObligāts

Pēdējās atjaunināšanas laiks.

format: "date-time"

Piemērs: "2026-01-01T12:00:00Z"

versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1

Papildu lauki: Nē

Meklēšanas noteikuma frāžu grupas

RulePhraseGroupData · Shēma · Datu shēmas: Meklēšanas analītika un noteikumi

localeVirkneObligāts: Šim pieprasījumam izvēlētā valoda.

Piemērs: "en"
phrasesMasīvs <Virkne> Obligāts: Meklēšanas noteikumā izmantotās frāzes.

Piemērs: ["example"]

Papildu lauki: Nē

Saraksts · Noteikumi — Meklēšanas analītika un noteikumi — Atbilde

RuleSummaryData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

created_atVirkneObligāts

Izveides laiks.

format: "date-time"

Piemērs: "2026-01-01T12:00:00Z"

enabledLoģiska vērtībaObligāts

Vai šis iestatījums ir ieslēgts.

Piemērs: true

idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā. (RuleSummaryData).

Piemērs: "example"

is_availableLoģiska vērtībaObligāts

Vai vienums ir pieejams šajā kontekstā.

Piemērs: true

market_scopeVirkneObligāts

Vai resurss attiecas uz visiem vai izvēlētiem tirgiem.

Ierobežojumi

enum: ["all", "selected"]

Piemērs: "all"

nameVirkneObligāts

Resursa nosaukums attiecīgajā kontekstā.

Piemērs: "Example"

updated_atVirkneObligāts

Pēdējās atjaunināšanas laiks.

format: "date-time"

Piemērs: "2026-01-01T12:00:00Z"

versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1

Papildu lauki: Nē

Atjaunināt · Noteikumi — Meklēšanas analītika un noteikumi — Pieprasījuma saturs

RuleUpdate · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

category_idsMasīvs <Virkne> Neobligāts

Saistīto kategoriju identifikatori.

maxItems: 100

Masīvs:minLength: 1maxLength: 63

enabledLoģiska vērtībaNeobligāts

Vai šis iestatījums ir ieslēgts.

expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 1maximum: 2147483647

Piemērs: 1

market_idsMasīvs <Virkne> Neobligāts

Izvēlēto tirgu identifikatori.

maxItems: 1000

Masīvs:minLength: 1maxLength: 63

market_scopeVirkneNeobligāts

Vai resurss attiecas uz visiem vai izvēlētiem tirgiem.

Ierobežojumi

enum: ["all", "selected"]

nameVirkneNeobligāts

Resursa nosaukums attiecīgajā kontekstā.

minLength: 1maxLength: 160

Piemērs: "Example"

phrasesMasīvs <Virkne> Neobligāts

Meklēšanas noteikumā izmantotās frāzes.

maxItems: 20

Masīvs:minLength: 1maxLength: 255

product_idsMasīvs <Virkne> Neobligāts

Saistīto produktu identifikatori.

maxItems: 100

Masīvs:minLength: 1maxLength: 63

Papildu lauki: Nē

Filtrs meklējumiem ar vai bez rezultātus neatgriezušām reizēm

ZeroResultScope · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

Virkne

Ierobežojumi

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

Papildu lauki: Jā