Dataskemaer: Søgeanalyse og regler

Dataskemaer: Søgeanalyse og regler. Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

Dataskemaer

Svarmetadata

AnalyticsMeta · Skema · Dataskemaer: Søgeanalyse og regler

periodAnalyticsPeriodData Obligatorisk: Rapporteringsperiode og dens grænser.

Eksempel: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idStrengObligatorisk: Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100

Eksempel: "example"

Yderligere felter: Nej

Rapporteringsperiode og dens grænser

AnalyticsPeriodData · Skema · Dataskemaer: Søgeanalyse og regler

as_ofStrengObligatorisk: Tidspunkt, som de rapporterede data gælder for.

format: "date-time"

Eksempel: "2026-01-02T00:00:00Z"
daysHeltalObligatorisk: Rapporteringsperiode i dage.

Eksempel: 1
started_atStrengObligatorisk: Startdato og -tidspunkt.

format: "date-time"

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

Yderligere felter: Nej

Vis liste · Søgeforespørgsler — Søgeanalyse og regler — Svar

AnalyticsResponse_list_MetricData__ · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

dataArray <MetricData > Obligatorisk: Eksempel på svar · AnalyticsResponse_list_MetricData__.

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

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

Yderligere felter: Nej

Hent · Søgeforespørgsler — Søgeanalyse og regler — Svar

AnalyticsResponse_list_OccurrenceData__ · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

dataArray <OccurrenceData > Obligatorisk: Eksempel på svar · AnalyticsResponse_list_OccurrenceData__.

Eksempel: [{"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 Obligatorisk: Svarmetadata.

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

Yderligere felter: Nej

Oversigt — Søgeanalyse og regler — Svar

AnalyticsResponse_OverviewData_ · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

dataOverviewData Obligatorisk: Eksempel på svar · OverviewData.

Eksempel: {"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 Obligatorisk: Svarmetadata.

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

Yderligere felter: Nej

Vis liste · Regler — Søgeanalyse og regler — Svar

ApiResponse_list_RuleSummaryData__ · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

dataArray <RuleSummaryData > Obligatorisk: Eksempel på svar · ApiResponse_list_RuleSummaryData__.

Eksempel: [{"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 Obligatorisk: Svarmetadata.

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

Yderligere felter: Nej

Hent · Regler — Søgeanalyse og regler — Svar

ApiResponse_RuleDetailData_ · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

dataRuleDetailData Obligatorisk: Eksempel på svar · RuleDetailData.

Eksempel: {"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 Obligatorisk: Svarmetadata.

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

Yderligere felter: Nej

Vis liste · Søgeforespørgsler — Søgeanalyse og regler — Svar

MetricData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

clicksHeltalObligatorisk: Antal klik.

Eksempel: 1
last_seen_atStrengObligatorisk: Tidspunkt for seneste forekomst.

format: "date-time"

Eksempel: "2026-01-01T12:00:00Z"
query_displayStrengObligatorisk: Søgefrase vist til en administrator.

Eksempel: "example"
query_hashStrengObligatorisk: Stabil identifikator for den grupperede søgefrase.

Eksempel: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
searchesHeltalObligatorisk: Antal søgninger.

Eksempel: 1
zero_resultsHeltalObligatorisk: Antal søgninger uden resultater.

Eksempel: 1

Yderligere felter: Nej

Hent · Søgeforespørgsler — Søgeanalyse og regler — Svar

OccurrenceData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

category_idStreng nullObligatorisk

Kategoriidentifikator.

Eksempel: "example"

category_result_countHeltalObligatorisk

Antal kategoriresultater.

Eksempel: 1

currency_codeStrengObligatorisk

Valutakode.

Eksempel: "PLN"

is_zero_resultsBoolesk værdiObligatorisk

Om søgningen ikke gav nogen resultater.

Eksempel: false

locale_codeStrengObligatorisk

Sprogkode.

Eksempel: "en"

market_idStrengObligatorisk

Markedsidentifikator returneret af kontekstendepunktet.

Eksempel: "example"

max_priceStreng nullObligatorisk

Højeste pris i det rapporterede interval.

Eksempel: "0.00"

min_priceStreng nullObligatorisk

Laveste pris i det rapporterede interval.

Eksempel: "0.00"

occurred_atStrengObligatorisk

Hændelsens dato og tidspunkt.

format: "date-time"

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

pageHeltalObligatorisk

Oplysninger om CMS-siden.

Eksempel: 1

product_result_countHeltalObligatorisk

Antal produktsøgeresultater.

Eksempel: 1

query_displayStrengObligatorisk

Søgefrase vist til en administrator.

Eksempel: "example"

request_idStrengObligatorisk

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

Eksempel: "example"

resultsArray <ResultSnapshotData > nullObligatorisk

Registrerede søgeresultater.

Eksempel:

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

Sorteringsnøgle.

Eksempel: "example"

sourceStrengObligatorisk

Kilden til den registrerede aktivitet.

Begrænsninger

enum: ["results", "autocomplete"]

Eksempel: "results"

Yderligere felter: Nej

Oversigt — Søgeanalyse og regler — Svar

OverviewData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

click_through_rateTalObligatorisk: Klikrate for de valgte søgedata.

Eksempel: 0
clicked_searchesHeltalObligatorisk: Antal søgninger med et klik.

Eksempel: 1
recentArray <RecentSearchData > Obligatorisk: Oplysninger om nylige søgninger.

Eksempel: [{"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"}]
searchesHeltalObligatorisk: Antal søgninger.

Eksempel: 1
zero_result_rateTalObligatorisk: Andel af søgninger uden resultater.

Eksempel: 0
zero_resultsHeltalObligatorisk: Antal søgninger uden resultater.

Eksempel: 1

Yderligere felter: Nej

Valgt sorteringsrækkefølge for resultaterne

QueryMetricSort · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

Streng

Begrænsninger

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

Yderligere felter: Ja

Oplysninger om nylige søgninger

RecentSearchData · Skema · Dataskemaer: Søgeanalyse og regler

is_zero_resultsBoolesk værdiObligatorisk

Om søgningen ikke gav nogen resultater.

Eksempel: false

locale_codeStrengObligatorisk

Sprogkode.

Eksempel: "en"

occurred_atStrengObligatorisk

Hændelsens dato og tidspunkt.

format: "date-time"

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

query_displayStrengObligatorisk

Søgefrase vist til en administrator.

Eksempel: "example"

query_hashStrengObligatorisk

Stabil identifikator for den grupperede søgefrase.

Eksempel: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idStrengObligatorisk

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

Eksempel: "example"

result_countHeltalObligatorisk

Antal søgeresultater.

Eksempel: 1

sourceStrengObligatorisk

Kilden til den registrerede aktivitet.

Begrænsninger

enum: ["results", "autocomplete"]

Eksempel: "results"

Yderligere felter: Nej

Registrerede søgeresultater

ResultSnapshotData · Skema · Dataskemaer: Søgeanalyse og regler

clickedBoolesk værdiObligatorisk

Om der blev klikket på resultatet.

Eksempel: false

entity_idStrengObligatorisk

Identifikator for den refererede entitet.

Eksempel: "example"

entity_typeStrengObligatorisk

Type for den refererede entitet.

Begrænsninger

enum: ["product", "category"]

Eksempel: "product"

image_urlStreng nullObligatorisk

Billedets URL.

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

numberStreng nullObligatorisk

Ordre- eller sagsnummer beregnet til mennesker.

Eksempel: "example"

placement_sourceStrengObligatorisk

Kilde, hvorfra ordren blev afgivet.

Begrænsninger

enum: ["organic", "merchandising"]

Eksempel: "organic"

positionHeltalObligatorisk

Placering i den sorterede samling.

Eksempel: 1

skuStrengObligatorisk

SKU-varekode.

Eksempel: "example"

slugStrengObligatorisk

URL-stisegment på det valgte sprog.

Eksempel: "example"

titleStrengObligatorisk

Titel på det valgte sprog.

Eksempel: "example"

Yderligere felter: Nej

Opret · Regler — Søgeanalyse og regler — Forespørgselsindhold

RuleCreate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

category_idsArray <Streng> Valgfrit

Identifikatorer for tilknyttede kategorier.

maxItems: 100

Array:minLength: 1maxLength: 63

enabledBoolesk værdiValgfrit

Om denne indstilling er aktiveret.

Standard: false

market_idsArray <Streng> Valgfrit

Identifikatorer for valgte markeder.

maxItems: 1000

Array:minLength: 1maxLength: 63

market_scopeStrengValgfrit

Om ressourcen gælder for alle eller udvalgte markeder.

Begrænsninger

enum: ["all", "selected"]

nameStrengObligatorisk

Ressourcens navn i den relevante kontekst.

minLength: 1maxLength: 160

Eksempel: "Example"

phrasesArray <Streng> Obligatorisk

Fraser anvendt af søgereglen.

minItems: 1maxItems: 20

Array:minLength: 1maxLength: 255

Eksempel: ["example"]

product_idsArray <Streng> Valgfrit

Identifikatorer for tilknyttede produkter.

maxItems: 100

Array:minLength: 1maxLength: 63

Eksempel: ["example"]

Yderligere felter: Nej

Hent · Regler — Søgeanalyse og regler — Svar

RuleDetailData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

category_idsArray <Streng> Obligatorisk

Identifikatorer for tilknyttede kategorier.

Eksempel: ["example"]

created_atStrengObligatorisk

Oprettelsestidspunkt.

format: "date-time"

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

enabledBoolesk værdiObligatorisk

Om denne indstilling er aktiveret.

Eksempel: true

idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. (RuleDetailData).

Eksempel: "example"

is_availableBoolesk værdiObligatorisk

Om varen er tilgængelig i denne kontekst.

Eksempel: true

market_idsArray <Streng> Obligatorisk

Identifikatorer for valgte markeder.

Eksempel: ["example"]

market_scopeStrengObligatorisk

Om ressourcen gælder for alle eller udvalgte markeder.

Begrænsninger

enum: ["all", "selected"]

Eksempel: "all"

nameStrengObligatorisk

Ressourcens navn i den relevante kontekst.

Eksempel: "Example"

phrase_groupsArray <RulePhraseGroupData > Obligatorisk

Grupper af søgeregelfraser.

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

product_idsArray <Streng> Obligatorisk

Identifikatorer for tilknyttede produkter.

Eksempel: ["example"]

updated_atStrengObligatorisk

Tidspunkt for seneste opdatering.

format: "date-time"

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

versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

Yderligere felter: Nej

Grupper af søgeregelfraser

RulePhraseGroupData · Skema · Dataskemaer: Søgeanalyse og regler

localeStrengObligatorisk: Sprog valgt til denne forespørgsel.

Eksempel: "en"
phrasesArray <Streng> Obligatorisk: Fraser anvendt af søgereglen.

Eksempel: ["example"]

Yderligere felter: Nej

Vis liste · Regler — Søgeanalyse og regler — Svar

RuleSummaryData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

created_atStrengObligatorisk

Oprettelsestidspunkt.

format: "date-time"

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

enabledBoolesk værdiObligatorisk

Om denne indstilling er aktiveret.

Eksempel: true

idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. (RuleSummaryData).

Eksempel: "example"

is_availableBoolesk værdiObligatorisk

Om varen er tilgængelig i denne kontekst.

Eksempel: true

market_scopeStrengObligatorisk

Om ressourcen gælder for alle eller udvalgte markeder.

Begrænsninger

enum: ["all", "selected"]

Eksempel: "all"

nameStrengObligatorisk

Ressourcens navn i den relevante kontekst.

Eksempel: "Example"

updated_atStrengObligatorisk

Tidspunkt for seneste opdatering.

format: "date-time"

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

versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

Yderligere felter: Nej

Opdater · Regler — Søgeanalyse og regler — Forespørgselsindhold

RuleUpdate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

category_idsArray <Streng> Valgfrit

Identifikatorer for tilknyttede kategorier.

maxItems: 100

Array:minLength: 1maxLength: 63

enabledBoolesk værdiValgfrit

Om denne indstilling er aktiveret.

expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 1maximum: 2147483647

Eksempel: 1

market_idsArray <Streng> Valgfrit

Identifikatorer for valgte markeder.

maxItems: 1000

Array:minLength: 1maxLength: 63

market_scopeStrengValgfrit

Om ressourcen gælder for alle eller udvalgte markeder.

Begrænsninger

enum: ["all", "selected"]

nameStrengValgfrit

Ressourcens navn i den relevante kontekst.

minLength: 1maxLength: 160

Eksempel: "Example"

phrasesArray <Streng> Valgfrit

Fraser anvendt af søgereglen.

maxItems: 20

Array:minLength: 1maxLength: 255

product_idsArray <Streng> Valgfrit

Identifikatorer for tilknyttede produkter.

maxItems: 100

Array:minLength: 1maxLength: 63

Yderligere felter: Nej

Filter, der vælger søgninger med eller uden forekomster uden resultater

ZeroResultScope · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

Streng

Begrænsninger

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

Yderligere felter: Ja