Datascheman: Sökanalys och sökregler

Datascheman: Sökanalys och sökregler. Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

Datascheman

Metadata för svaret

AnalyticsMeta · Schema · Datascheman: Sökanalys och sökregler

periodAnalyticsPeriodData Obligatoriskt: Rapporteringsperiod och dess gränser.

Exempel: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idSträngObligatoriskt: Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100

Exempel: "example"

Ytterligare fält: Nej

Rapporteringsperiod och dess gränser

AnalyticsPeriodData · Schema · Datascheman: Sökanalys och sökregler

as_ofSträngObligatoriskt: Tidpunkt som de rapporterade uppgifterna avser.

format: "date-time"

Exempel: "2026-01-02T00:00:00Z"
daysHeltalObligatoriskt: Rapporteringsperiod i dagar.

Exempel: 1
started_atSträngObligatoriskt: Startdatum och starttid.

format: "date-time"

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

Ytterligare fält: Nej

Lista · Sökfrågor — Sökanalys och sökregler — Svar

AnalyticsResponse_list_MetricData__ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

dataArray <MetricData > Obligatoriskt: Exempel på svar · AnalyticsResponse_list_MetricData__.

Exempel: [{"clicks":1,"last_seen_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","searches":1,"zero_results":1}]
metaAnalyticsPageMeta AnalyticsMeta Obligatoriskt: Metadata för svaret.

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

Ytterligare fält: Nej

Hämta · Sökfrågor — Sökanalys och sökregler — Svar

AnalyticsResponse_list_OccurrenceData__ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

dataArray <OccurrenceData > Obligatoriskt: Exempel på svar · AnalyticsResponse_list_OccurrenceData__.

Exempel: [{"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 Obligatoriskt: Metadata för svaret.

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

Ytterligare fält: Nej

Sammanfattning — Sökanalys och sökregler — Svar

AnalyticsResponse_OverviewData_ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

dataOverviewData Obligatoriskt: Exempel på svar · OverviewData.

Exempel: {"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 Obligatoriskt: Metadata för svaret.

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

Ytterligare fält: Nej

Lista · Regler — Sökanalys och sökregler — Svar

ApiResponse_list_RuleSummaryData__ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

dataArray <RuleSummaryData > Obligatoriskt: Exempel på svar · ApiResponse_list_RuleSummaryData__.

Exempel: [{"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 Obligatoriskt: Metadata för svaret.

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

Ytterligare fält: Nej

Hämta · Regler — Sökanalys och sökregler — Svar

ApiResponse_RuleDetailData_ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

dataRuleDetailData Obligatoriskt: Exempel på svar · RuleDetailData.

Exempel: {"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 Obligatoriskt: Metadata för svaret.

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

Ytterligare fält: Nej

Lista · Sökfrågor — Sökanalys och sökregler — Svar

MetricData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

clicksHeltalObligatoriskt: Antal klick.

Exempel: 1
last_seen_atSträngObligatoriskt: Tidpunkt för senaste förekomsten.

format: "date-time"

Exempel: "2026-01-01T12:00:00Z"
query_displaySträngObligatoriskt: Sökfras som visas för administratören.

Exempel: "example"
query_hashSträngObligatoriskt: Stabil identifierare för den grupperade sökfrasen.

Exempel: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
searchesHeltalObligatoriskt: Antal sökningar.

Exempel: 1
zero_resultsHeltalObligatoriskt: Antal sökningar utan resultat.

Exempel: 1

Ytterligare fält: Nej

Hämta · Sökfrågor — Sökanalys och sökregler — Svar

OccurrenceData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

category_idSträng nullObligatoriskt

Kategorins identifierare.

Exempel: "example"

category_result_countHeltalObligatoriskt

Antal kategoriträffar.

Exempel: 1

currency_codeSträngObligatoriskt

Valutakod.

Exempel: "PLN"

is_zero_resultsBooleskt värdeObligatoriskt

Anger om sökningen saknade resultat.

Exempel: false

locale_codeSträngObligatoriskt

Språkkod.

Exempel: "en"

market_idSträngObligatoriskt

Marknadsidentifierare returnerad av kontextendpointen.

Exempel: "example"

max_priceSträng nullObligatoriskt

Högsta pris i det rapporterade intervallet.

Exempel: "0.00"

min_priceSträng nullObligatoriskt

Lägsta pris i det rapporterade intervallet.

Exempel: "0.00"

occurred_atSträngObligatoriskt

Händelsens datum och tid.

format: "date-time"

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

pageHeltalObligatoriskt

Information om CMS-sidan.

Exempel: 1

product_result_countHeltalObligatoriskt

Antal produktträffar i sökningen.

Exempel: 1

query_displaySträngObligatoriskt

Sökfras som visas för administratören.

Exempel: "example"

request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

Exempel: "example"

resultsArray <ResultSnapshotData > nullObligatoriskt

Registrerade sökresultat.

Exempel:

[{"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_keySträngObligatoriskt

Sorteringsnyckel.

Exempel: "example"

sourceSträngObligatoriskt

Källa för registrerad aktivitet.

Begränsningar

enum: ["results", "autocomplete"]

Exempel: "results"

Ytterligare fält: Nej

Sammanfattning — Sökanalys och sökregler — Svar

OverviewData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

click_through_rateTalObligatoriskt: Klickfrekvens för valda sökdata.

Exempel: 0
clicked_searchesHeltalObligatoriskt: Antal sökningar med ett klick.

Exempel: 1
recentArray <RecentSearchData > Obligatoriskt: Information om senaste sökningarna.

Exempel: [{"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"}]
searchesHeltalObligatoriskt: Antal sökningar.

Exempel: 1
zero_result_rateTalObligatoriskt: Andel sökningar utan resultat.

Exempel: 0
zero_resultsHeltalObligatoriskt: Antal sökningar utan resultat.

Exempel: 1

Ytterligare fält: Nej

Vald sorteringsordning för resultaten

QueryMetricSort · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

Sträng

Begränsningar

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

Ytterligare fält: Ja

Information om senaste sökningarna

RecentSearchData · Schema · Datascheman: Sökanalys och sökregler

is_zero_resultsBooleskt värdeObligatoriskt

Anger om sökningen saknade resultat.

Exempel: false

locale_codeSträngObligatoriskt

Språkkod.

Exempel: "en"

occurred_atSträngObligatoriskt

Händelsens datum och tid.

format: "date-time"

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

query_displaySträngObligatoriskt

Sökfras som visas för administratören.

Exempel: "example"

query_hashSträngObligatoriskt

Stabil identifierare för den grupperade sökfrasen.

Exempel: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

Exempel: "example"

result_countHeltalObligatoriskt

Antal sökresultat.

Exempel: 1

sourceSträngObligatoriskt

Källa för registrerad aktivitet.

Begränsningar

enum: ["results", "autocomplete"]

Exempel: "results"

Ytterligare fält: Nej

Registrerade sökresultat

ResultSnapshotData · Schema · Datascheman: Sökanalys och sökregler

clickedBooleskt värdeObligatoriskt

Anger om resultatet klickades.

Exempel: false

entity_idSträngObligatoriskt

Identifierare för den refererade entiteten.

Exempel: "example"

entity_typeSträngObligatoriskt

Typ av refererad entitet.

Begränsningar

enum: ["product", "category"]

Exempel: "product"

image_urlSträng nullObligatoriskt

Bildens URL.

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

numberSträng nullObligatoriskt

Beställnings- eller ärendenummer som visas för användaren.

Exempel: "example"

placement_sourceSträngObligatoriskt

Källa som beställningen skapades från.

Begränsningar

enum: ["organic", "merchandising"]

Exempel: "organic"

positionHeltalObligatoriskt

Position i den ordnade samlingen.

Exempel: 1

skuSträngObligatoriskt

Artikelns SKU-kod.

Exempel: "example"

slugSträngObligatoriskt

URL-segment på valt språk.

Exempel: "example"

titleSträngObligatoriskt

Titel på valt språk.

Exempel: "example"

Ytterligare fält: Nej

Skapa · Regler — Sökanalys och sökregler — Begärans innehåll

RuleCreate · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

category_idsArray <Sträng> Valfritt

Identifierare för relaterade kategorier.

maxItems: 100

Array:minLength: 1maxLength: 63

enabledBooleskt värdeValfritt

Anger om inställningen är aktiverad.

Standardvärde: false

market_idsArray <Sträng> Valfritt

Identifierare för valda marknader.

maxItems: 1000

Array:minLength: 1maxLength: 63

market_scopeSträngValfritt

Anger om resursen gäller alla eller valda marknader.

Begränsningar

enum: ["all", "selected"]

nameSträngObligatoriskt

Resursens namn i aktuell kontext.

minLength: 1maxLength: 160

Exempel: "Example"

phrasesArray <Sträng> Obligatoriskt

Fraser som används av sökregeln.

minItems: 1maxItems: 20

Array:minLength: 1maxLength: 255

Exempel: ["example"]

product_idsArray <Sträng> Valfritt

Identifierare för relaterade produkter.

maxItems: 100

Array:minLength: 1maxLength: 63

Exempel: ["example"]

Ytterligare fält: Nej

Hämta · Regler — Sökanalys och sökregler — Svar

RuleDetailData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

category_idsArray <Sträng> Obligatoriskt

Identifierare för relaterade kategorier.

Exempel: ["example"]

created_atSträngObligatoriskt

Tidpunkt för skapande.

format: "date-time"

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

enabledBooleskt värdeObligatoriskt

Anger om inställningen är aktiverad.

Exempel: true

idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. (RuleDetailData).

Exempel: "example"

is_availableBooleskt värdeObligatoriskt

Anger om artikeln är tillgänglig i denna kontext.

Exempel: true

market_idsArray <Sträng> Obligatoriskt

Identifierare för valda marknader.

Exempel: ["example"]

market_scopeSträngObligatoriskt

Anger om resursen gäller alla eller valda marknader.

Begränsningar

enum: ["all", "selected"]

Exempel: "all"

nameSträngObligatoriskt

Resursens namn i aktuell kontext.

Exempel: "Example"

phrase_groupsArray <RulePhraseGroupData > Obligatoriskt

Grupper av fraser i sökregler.

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

product_idsArray <Sträng> Obligatoriskt

Identifierare för relaterade produkter.

Exempel: ["example"]

updated_atSträngObligatoriskt

Tidpunkt för senaste uppdatering.

format: "date-time"

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

versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Exempel: 1

Ytterligare fält: Nej

Grupper av fraser i sökregler

RulePhraseGroupData · Schema · Datascheman: Sökanalys och sökregler

localeSträngObligatoriskt: Språk valt för denna begäran.

Exempel: "en"
phrasesArray <Sträng> Obligatoriskt: Fraser som används av sökregeln.

Exempel: ["example"]

Ytterligare fält: Nej

Lista · Regler — Sökanalys och sökregler — Svar

RuleSummaryData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

created_atSträngObligatoriskt

Tidpunkt för skapande.

format: "date-time"

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

enabledBooleskt värdeObligatoriskt

Anger om inställningen är aktiverad.

Exempel: true

idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. (RuleSummaryData).

Exempel: "example"

is_availableBooleskt värdeObligatoriskt

Anger om artikeln är tillgänglig i denna kontext.

Exempel: true

market_scopeSträngObligatoriskt

Anger om resursen gäller alla eller valda marknader.

Begränsningar

enum: ["all", "selected"]

Exempel: "all"

nameSträngObligatoriskt

Resursens namn i aktuell kontext.

Exempel: "Example"

updated_atSträngObligatoriskt

Tidpunkt för senaste uppdatering.

format: "date-time"

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

versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Exempel: 1

Ytterligare fält: Nej

Uppdatera · Regler — Sökanalys och sökregler — Begärans innehåll

RuleUpdate · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

category_idsArray <Sträng> Valfritt

Identifierare för relaterade kategorier.

maxItems: 100

Array:minLength: 1maxLength: 63

enabledBooleskt värdeValfritt

Anger om inställningen är aktiverad.

expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 2147483647

Exempel: 1

market_idsArray <Sträng> Valfritt

Identifierare för valda marknader.

maxItems: 1000

Array:minLength: 1maxLength: 63

market_scopeSträngValfritt

Anger om resursen gäller alla eller valda marknader.

Begränsningar

enum: ["all", "selected"]

nameSträngValfritt

Resursens namn i aktuell kontext.

minLength: 1maxLength: 160

Exempel: "Example"

phrasesArray <Sträng> Valfritt

Fraser som används av sökregeln.

maxItems: 20

Array:minLength: 1maxLength: 255

product_idsArray <Sträng> Valfritt

Identifierare för relaterade produkter.

maxItems: 100

Array:minLength: 1maxLength: 63

Ytterligare fält: Nej

Filter som väljer sökningar med eller utan förekomster utan resultat

ZeroResultScope · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

Sträng

Begränsningar

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

Ytterligare fält: Ja