Dataskjemaer: Søkeanalyse og regler

Dataskjemaer: Søkeanalyse og regler. Felter, typer og begrensninger for data som API-et mottar eller returnerer.

Dataskjemaer

Svarmetadata

AnalyticsMeta · Skjema · Dataskjemaer: Søkeanalyse og regler

periodAnalyticsPeriodData Obligatorisk: Rapporteringsperiode og grensene for den.

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

minLength: 1maxLength: 100

Eksempel: "example"

Ytterligere felt: Nei

Rapporteringsperiode og grensene for den

AnalyticsPeriodData · Skjema · Dataskjemaer: Søkeanalyse og regler

as_ofStrengObligatorisk: Tidspunktet de rapporterte dataene gjelder for.

format: "date-time"

Eksempel: "2026-01-02T00:00:00Z"
daysHeltallObligatorisk: Rapporteringsperiode i dager.

Eksempel: 1
started_atStrengObligatorisk: Startdato og -tidspunkt.

format: "date-time"

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

Ytterligere felt: Nei

Vis liste · Søk — Søkeanalyse og regler — Svar

AnalyticsResponse_list_MetricData__ · Felter, typer og begrensninger for data som API-et mottar 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"}

Ytterligere felt: Nei

Hent · Søk — Søkeanalyse og regler — Svar

AnalyticsResponse_list_OccurrenceData__ · Felter, typer og begrensninger for data som API-et mottar 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"}

Ytterligere felt: Nei

Sammendrag — Søkeanalyse og regler — Svar

AnalyticsResponse_OverviewData_ · Felter, typer og begrensninger for data som API-et mottar 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"}

Ytterligere felt: Nei

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

ApiResponse_list_RuleSummaryData__ · Felter, typer og begrensninger for data som API-et mottar 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"}

Ytterligere felt: Nei

Hent · Regler — Søkeanalyse og regler — Svar

ApiResponse_RuleDetailData_ · Felter, typer og begrensninger for data som API-et mottar 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"}

Ytterligere felt: Nei

Vis liste · Søk — Søkeanalyse og regler — Svar

MetricData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

clicksHeltallObligatorisk: Antall klikk.

Eksempel: 1
last_seen_atStrengObligatorisk: Tidspunkt for siste forekomst.

format: "date-time"

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

Eksempel: "example"
query_hashStrengObligatorisk: Stabil identifikator for den grupperte søkefrasen.

Eksempel: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
searchesHeltallObligatorisk: Antall søk.

Eksempel: 1
zero_resultsHeltallObligatorisk: Antall søk uten resultater.

Eksempel: 1

Ytterligere felt: Nei

Hent · Søk — Søkeanalyse og regler — Svar

OccurrenceData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

category_idStreng nullObligatorisk

Kategoriidentifikator.

Eksempel: "example"

category_result_countHeltallObligatorisk

Antall kategoriresultater.

Eksempel: 1

currency_codeStrengObligatorisk

Valutakode.

Eksempel: "PLN"

is_zero_resultsBoolsk verdiObligatorisk

Om søket ikke ga noen resultater.

Eksempel: false

locale_codeStrengObligatorisk

Språkkode.

Eksempel: "en"

market_idStrengObligatorisk

Markedsidentifikator returnert av kontekstendepunktet.

Eksempel: "example"

max_priceStreng nullObligatorisk

Høyeste pris i det rapporterte intervallet.

Eksempel: "0.00"

min_priceStreng nullObligatorisk

Laveste pris i det rapporterte intervallet.

Eksempel: "0.00"

occurred_atStrengObligatorisk

Dato og tidspunkt for hendelsen.

format: "date-time"

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

pageHeltallObligatorisk

Informasjon om CMS-siden.

Eksempel: 1

product_result_countHeltallObligatorisk

Antall produktsøkeresultater.

Eksempel: 1

query_displayStrengObligatorisk

Søkefrase vist til en administrator.

Eksempel: "example"

request_idStrengObligatorisk

Saksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.

Eksempel: "example"

resultsArray <ResultSnapshotData > nullObligatorisk

Registrerte søkeresultater.

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økkel.

Eksempel: "example"

sourceStrengObligatorisk

Kilden til den registrerte aktiviteten.

Begrensninger

enum: ["results", "autocomplete"]

Eksempel: "results"

Ytterligere felt: Nei

Sammendrag — Søkeanalyse og regler — Svar

OverviewData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

click_through_rateTallObligatorisk: Klikkrate for de valgte søkedataene.

Eksempel: 0
clicked_searchesHeltallObligatorisk: Antall søk med et klikk.

Eksempel: 1
recentArray <RecentSearchData > Obligatorisk: Informasjon om nylige søk.

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"}]
searchesHeltallObligatorisk: Antall søk.

Eksempel: 1
zero_result_rateTallObligatorisk: Andel søk som ikke ga resultater.

Eksempel: 0
zero_resultsHeltallObligatorisk: Antall søk uten resultater.

Eksempel: 1

Ytterligere felt: Nei

Valgt sorteringsrekkefølge for resultatene

QueryMetricSort · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

Streng

Begrensninger

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

Ytterligere felt: Ja

Informasjon om nylige søk

RecentSearchData · Skjema · Dataskjemaer: Søkeanalyse og regler

is_zero_resultsBoolsk verdiObligatorisk

Om søket ikke ga noen resultater.

Eksempel: false

locale_codeStrengObligatorisk

Språkkode.

Eksempel: "en"

occurred_atStrengObligatorisk

Dato og tidspunkt for hendelsen.

format: "date-time"

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

query_displayStrengObligatorisk

Søkefrase vist til en administrator.

Eksempel: "example"

query_hashStrengObligatorisk

Stabil identifikator for den grupperte søkefrasen.

Eksempel: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idStrengObligatorisk

Saksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.

Eksempel: "example"

result_countHeltallObligatorisk

Antall søkeresultater.

Eksempel: 1

sourceStrengObligatorisk

Kilden til den registrerte aktiviteten.

Begrensninger

enum: ["results", "autocomplete"]

Eksempel: "results"

Ytterligere felt: Nei

Registrerte søkeresultater

ResultSnapshotData · Skjema · Dataskjemaer: Søkeanalyse og regler

clickedBoolsk verdiObligatorisk

Om resultatet ble klikket på.

Eksempel: false

entity_idStrengObligatorisk

Identifikator for den refererte entiteten.

Eksempel: "example"

entity_typeStrengObligatorisk

Type for den refererte entiteten.

Begrensninger

enum: ["product", "category"]

Eksempel: "product"

image_urlStreng nullObligatorisk

Bildets URL.

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

numberStreng nullObligatorisk

Ordre- eller saksnummer beregnet på mennesker.

Eksempel: "example"

placement_sourceStrengObligatorisk

Kilden ordren ble lagt inn fra.

Begrensninger

enum: ["organic", "merchandising"]

Eksempel: "organic"

positionHeltallObligatorisk

Plassering i den sorterte samlingen.

Eksempel: 1

skuStrengObligatorisk

SKU-varekode.

Eksempel: "example"

slugStrengObligatorisk

URL-stisegment på valgt språk.

Eksempel: "example"

titleStrengObligatorisk

Tittel på valgt språk.

Eksempel: "example"

Ytterligere felt: Nei

Opprett · Regler — Søkeanalyse og regler — Forespørselsinnhold

RuleCreate · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

category_idsArray <Streng> Valgfritt

Identifikatorer for tilknyttede kategorier.

maxItems: 100

Array:minLength: 1maxLength: 63

enabledBoolsk verdiValgfritt

Om denne innstillingen er aktivert.

Standard: false

market_idsArray <Streng> Valgfritt

Identifikatorer for valgte markeder.

maxItems: 1000

Array:minLength: 1maxLength: 63

market_scopeStrengValgfritt

Om ressursen gjelder alle eller utvalgte markeder.

Begrensninger

enum: ["all", "selected"]

nameStrengObligatorisk

Ressursens navn i den relevante konteksten.

minLength: 1maxLength: 160

Eksempel: "Example"

phrasesArray <Streng> Obligatorisk

Fraser brukt av søkeregelen.

minItems: 1maxItems: 20

Array:minLength: 1maxLength: 255

Eksempel: ["example"]

product_idsArray <Streng> Valgfritt

Identifikatorer for tilknyttede produkter.

maxItems: 100

Array:minLength: 1maxLength: 63

Eksempel: ["example"]

Ytterligere felt: Nei

Hent · Regler — Søkeanalyse og regler — Svar

RuleDetailData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

category_idsArray <Streng> Obligatorisk

Identifikatorer for tilknyttede kategorier.

Eksempel: ["example"]

created_atStrengObligatorisk

Opprettelsestidspunkt.

format: "date-time"

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

enabledBoolsk verdiObligatorisk

Om denne innstillingen er aktivert.

Eksempel: true

idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres. (RuleDetailData).

Eksempel: "example"

is_availableBoolsk verdiObligatorisk

Om varen er tilgjengelig i denne konteksten.

Eksempel: true

market_idsArray <Streng> Obligatorisk

Identifikatorer for valgte markeder.

Eksempel: ["example"]

market_scopeStrengObligatorisk

Om ressursen gjelder alle eller utvalgte markeder.

Begrensninger

enum: ["all", "selected"]

Eksempel: "all"

nameStrengObligatorisk

Ressursens navn i den relevante konteksten.

Eksempel: "Example"

phrase_groupsArray <RulePhraseGroupData > Obligatorisk

Grupper av søkeregelfraser.

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

product_idsArray <Streng> Obligatorisk

Identifikatorer for tilknyttede produkter.

Eksempel: ["example"]

updated_atStrengObligatorisk

Tidspunkt for siste oppdatering.

format: "date-time"

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

versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

Ytterligere felt: Nei

Grupper av søkeregelfraser

RulePhraseGroupData · Skjema · Dataskjemaer: Søkeanalyse og regler

localeStrengObligatorisk: Språk valgt for denne forespørselen.

Eksempel: "en"
phrasesArray <Streng> Obligatorisk: Fraser brukt av søkeregelen.

Eksempel: ["example"]

Ytterligere felt: Nei

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

RuleSummaryData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

created_atStrengObligatorisk

Opprettelsestidspunkt.

format: "date-time"

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

enabledBoolsk verdiObligatorisk

Om denne innstillingen er aktivert.

Eksempel: true

idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres. (RuleSummaryData).

Eksempel: "example"

is_availableBoolsk verdiObligatorisk

Om varen er tilgjengelig i denne konteksten.

Eksempel: true

market_scopeStrengObligatorisk

Om ressursen gjelder alle eller utvalgte markeder.

Begrensninger

enum: ["all", "selected"]

Eksempel: "all"

nameStrengObligatorisk

Ressursens navn i den relevante konteksten.

Eksempel: "Example"

updated_atStrengObligatorisk

Tidspunkt for siste oppdatering.

format: "date-time"

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

versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

Ytterligere felt: Nei

Oppdater · Regler — Søkeanalyse og regler — Forespørselsinnhold

RuleUpdate · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

category_idsArray <Streng> Valgfritt

Identifikatorer for tilknyttede kategorier.

maxItems: 100

Array:minLength: 1maxLength: 63

enabledBoolsk verdiValgfritt

Om denne innstillingen er aktivert.

expected_versionHeltallObligatorisk

Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

minimum: 1maximum: 2147483647

Eksempel: 1

market_idsArray <Streng> Valgfritt

Identifikatorer for valgte markeder.

maxItems: 1000

Array:minLength: 1maxLength: 63

market_scopeStrengValgfritt

Om ressursen gjelder alle eller utvalgte markeder.

Begrensninger

enum: ["all", "selected"]

nameStrengValgfritt

Ressursens navn i den relevante konteksten.

minLength: 1maxLength: 160

Eksempel: "Example"

phrasesArray <Streng> Valgfritt

Fraser brukt av søkeregelen.

maxItems: 20

Array:minLength: 1maxLength: 255

product_idsArray <Streng> Valgfritt

Identifikatorer for tilknyttede produkter.

maxItems: 100

Array:minLength: 1maxLength: 63

Ytterligere felt: Nei

Filter som velger søk med eller uten forekomster uten resultater

ZeroResultScope · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

Streng

Begrensninger

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

Ytterligere felt: Ja