Datenschemas: Suchanalysen und Regeln

Datenschemas: Suchanalysen und Regeln. Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

Datenschemas

Metadaten der Antwort

AnalyticsMeta · Schema · Datenschemas: Suchanalysen und Regeln

periodAnalyticsPeriodData Erforderlich: Berichtszeitraum und seine Grenzen.

Beispiel: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idZeichenfolgeErforderlich: Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

minLength: 1maxLength: 100

Beispiel: "example"

Zusätzliche Felder: Nein

Berichtszeitraum und seine Grenzen

AnalyticsPeriodData · Schema · Datenschemas: Suchanalysen und Regeln

as_ofZeichenfolgeErforderlich: Zeitpunkt, auf den sich die gemeldeten Daten beziehen.

format: "date-time"

Beispiel: "2026-01-02T00:00:00Z"
daysGanzzahlErforderlich: Berichtszeitraum in Tagen.

Beispiel: 1
started_atZeichenfolgeErforderlich: Beginn mit Datum und Uhrzeit.

format: "date-time"

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

Zusätzliche Felder: Nein

Auflisten · Suchanfragen — Suchanalysen und Regeln — Antwort

AnalyticsResponse_list_MetricData__ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

dataArray <MetricData > Erforderlich: Beispielantwort · AnalyticsResponse_list_MetricData__.

Beispiel: [{"clicks":1,"last_seen_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","searches":1,"zero_results":1}]
metaAnalyticsPageMeta AnalyticsMeta Erforderlich: Metadaten der Antwort.

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

Zusätzliche Felder: Nein

Abrufen · Suchanfragen — Suchanalysen und Regeln — Antwort

AnalyticsResponse_list_OccurrenceData__ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

dataArray <OccurrenceData > Erforderlich: Beispielantwort · AnalyticsResponse_list_OccurrenceData__.

Beispiel: [{"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 Erforderlich: Metadaten der Antwort.

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

Zusätzliche Felder: Nein

Übersicht — Suchanalysen und Regeln — Antwort

AnalyticsResponse_OverviewData_ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

dataOverviewData Erforderlich: Beispielantwort · OverviewData.

Beispiel: {"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 Erforderlich: Metadaten der Antwort.

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

Zusätzliche Felder: Nein

Auflisten · Regeln — Suchanalysen und Regeln — Antwort

ApiResponse_list_RuleSummaryData__ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

dataArray <RuleSummaryData > Erforderlich: Beispielantwort · ApiResponse_list_RuleSummaryData__.

Beispiel: [{"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 Erforderlich: Metadaten der Antwort.

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

Zusätzliche Felder: Nein

Abrufen · Regeln — Suchanalysen und Regeln — Antwort

ApiResponse_RuleDetailData_ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

dataRuleDetailData Erforderlich: Beispielantwort · RuleDetailData.

Beispiel: {"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 Erforderlich: Metadaten der Antwort.

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

Zusätzliche Felder: Nein

Auflisten · Suchanfragen — Suchanalysen und Regeln — Antwort

MetricData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

clicksGanzzahlErforderlich: Anzahl der Klicks.

Beispiel: 1
last_seen_atZeichenfolgeErforderlich: Zeitpunkt des letzten Auftretens.

format: "date-time"

Beispiel: "2026-01-01T12:00:00Z"
query_displayZeichenfolgeErforderlich: Im Administrationsbereich angezeigte Suchphrase.

Beispiel: "example"
query_hashZeichenfolgeErforderlich: Stabile Kennung der gruppierten Suchphrase.

Beispiel: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
searchesGanzzahlErforderlich: Anzahl der Suchvorgänge.

Beispiel: 1
zero_resultsGanzzahlErforderlich: Anzahl der Suchvorgänge ohne Ergebnis.

Beispiel: 1

Zusätzliche Felder: Nein

Abrufen · Suchanfragen — Suchanalysen und Regeln — Antwort

OccurrenceData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

category_idZeichenfolge nullErforderlich

Kategorienkennung.

Beispiel: "example"

category_result_countGanzzahlErforderlich

Anzahl der Kategorieergebnisse.

Beispiel: 1

currency_codeZeichenfolgeErforderlich

Währungscode.

Beispiel: "PLN"

is_zero_resultsBoolescher WertErforderlich

Gibt an, ob die Suche keine Ergebnisse geliefert hat.

Beispiel: false

locale_codeZeichenfolgeErforderlich

Sprachcode.

Beispiel: "en"

market_idZeichenfolgeErforderlich

Vom Kontext-Endpunkt zurückgegebene Marktkennung.

Beispiel: "example"

max_priceZeichenfolge nullErforderlich

Höchster Preis im angegebenen Bereich.

Beispiel: "0.00"

min_priceZeichenfolge nullErforderlich

Niedrigster Preis im angegebenen Bereich.

Beispiel: "0.00"

occurred_atZeichenfolgeErforderlich

Datum und Uhrzeit des Ereignisses.

format: "date-time"

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

pageGanzzahlErforderlich

Informationen zur CMS-Seite.

Beispiel: 1

product_result_countGanzzahlErforderlich

Anzahl der Produktsuchergebnisse.

Beispiel: 1

query_displayZeichenfolgeErforderlich

Im Administrationsbereich angezeigte Suchphrase.

Beispiel: "example"

request_idZeichenfolgeErforderlich

Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

Beispiel: "example"

resultsArray <ResultSnapshotData > nullErforderlich

Gespeicherte Suchergebnisse.

Beispiel:

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

Sortierschlüssel.

Beispiel: "example"

sourceZeichenfolgeErforderlich

Quelle der aufgezeichneten Aktivität.

Einschränkungen

enum: ["results", "autocomplete"]

Beispiel: "results"

Zusätzliche Felder: Nein

Übersicht — Suchanalysen und Regeln — Antwort

OverviewData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

click_through_rateZahlErforderlich: Klickrate für die ausgewählten Suchdaten.

Beispiel: 0
clicked_searchesGanzzahlErforderlich: Anzahl der Suchvorgänge mit einem Klick.

Beispiel: 1
recentArray <RecentSearchData > Erforderlich: Informationen zu den letzten Suchvorgängen.

Beispiel: [{"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"}]
searchesGanzzahlErforderlich: Anzahl der Suchvorgänge.

Beispiel: 1
zero_result_rateZahlErforderlich: Anteil der Suchvorgänge ohne Ergebnis.

Beispiel: 0
zero_resultsGanzzahlErforderlich: Anzahl der Suchvorgänge ohne Ergebnis.

Beispiel: 1

Zusätzliche Felder: Nein

Ausgewählte Sortierreihenfolge der Ergebnisse

QueryMetricSort · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

Zeichenfolge

Einschränkungen

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

Zusätzliche Felder: Ja

Informationen zu den letzten Suchvorgängen

RecentSearchData · Schema · Datenschemas: Suchanalysen und Regeln

is_zero_resultsBoolescher WertErforderlich

Gibt an, ob die Suche keine Ergebnisse geliefert hat.

Beispiel: false

locale_codeZeichenfolgeErforderlich

Sprachcode.

Beispiel: "en"

occurred_atZeichenfolgeErforderlich

Datum und Uhrzeit des Ereignisses.

format: "date-time"

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

query_displayZeichenfolgeErforderlich

Im Administrationsbereich angezeigte Suchphrase.

Beispiel: "example"

query_hashZeichenfolgeErforderlich

Stabile Kennung der gruppierten Suchphrase.

Beispiel: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idZeichenfolgeErforderlich

Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

Beispiel: "example"

result_countGanzzahlErforderlich

Anzahl der Suchergebnisse.

Beispiel: 1

sourceZeichenfolgeErforderlich

Quelle der aufgezeichneten Aktivität.

Einschränkungen

enum: ["results", "autocomplete"]

Beispiel: "results"

Zusätzliche Felder: Nein

Gespeicherte Suchergebnisse

ResultSnapshotData · Schema · Datenschemas: Suchanalysen und Regeln

clickedBoolescher WertErforderlich

Gibt an, ob das Ergebnis angeklickt wurde.

Beispiel: false

entity_idZeichenfolgeErforderlich

Kennung des referenzierten Objekts.

Beispiel: "example"

entity_typeZeichenfolgeErforderlich

Typ des referenzierten Objekts.

Einschränkungen

enum: ["product", "category"]

Beispiel: "product"

image_urlZeichenfolge nullErforderlich

Bild-URL.

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

numberZeichenfolge nullErforderlich

Für Benutzer sichtbare Bestell- oder Vorgangsnummer.

Beispiel: "example"

placement_sourceZeichenfolgeErforderlich

Quelle der Bestellaufgabe.

Einschränkungen

enum: ["organic", "merchandising"]

Beispiel: "organic"

positionGanzzahlErforderlich

Position in der geordneten Sammlung.

Beispiel: 1

skuZeichenfolgeErforderlich

Artikelcode der Lagerhaltungseinheit.

Beispiel: "example"

slugZeichenfolgeErforderlich

URL-Pfadsegment in der ausgewählten Sprache.

Beispiel: "example"

titleZeichenfolgeErforderlich

Titel in der ausgewählten Sprache.

Beispiel: "example"

Zusätzliche Felder: Nein

Erstellen · Regeln — Suchanalysen und Regeln — Anfrageinhalt

RuleCreate · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

category_idsArray <Zeichenfolge> Optional

Kennungen der zugehörigen Kategorien.

maxItems: 100

Array:minLength: 1maxLength: 63

enabledBoolescher WertOptional

Gibt an, ob diese Einstellung aktiviert ist.

Standardwert: false

market_idsArray <Zeichenfolge> Optional

Kennungen der ausgewählten Märkte.

maxItems: 1000

Array:minLength: 1maxLength: 63

market_scopeZeichenfolgeOptional

Gibt an, ob alle oder nur ausgewählte Märkte gelten.

Einschränkungen

enum: ["all", "selected"]

nameZeichenfolgeErforderlich

Name der Ressource im jeweiligen Kontext.

minLength: 1maxLength: 160

Beispiel: "Example"

phrasesArray <Zeichenfolge> Erforderlich

Von der Suchregel verwendete Phrasen.

minItems: 1maxItems: 20

Array:minLength: 1maxLength: 255

Beispiel: ["example"]

product_idsArray <Zeichenfolge> Optional

Kennungen der zugehörigen Produkte.

maxItems: 100

Array:minLength: 1maxLength: 63

Beispiel: ["example"]

Zusätzliche Felder: Nein

Abrufen · Regeln — Suchanalysen und Regeln — Antwort

RuleDetailData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

category_idsArray <Zeichenfolge> Erforderlich

Kennungen der zugehörigen Kategorien.

Beispiel: ["example"]

created_atZeichenfolgeErforderlich

Zeitpunkt der Erstellung.

format: "date-time"

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

enabledBoolescher WertErforderlich

Gibt an, ob diese Einstellung aktiviert ist.

Beispiel: true

idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen. (RuleDetailData).

Beispiel: "example"

is_availableBoolescher WertErforderlich

Gibt an, ob der Artikel in diesem Kontext verfügbar ist.

Beispiel: true

market_idsArray <Zeichenfolge> Erforderlich

Kennungen der ausgewählten Märkte.

Beispiel: ["example"]

market_scopeZeichenfolgeErforderlich

Gibt an, ob alle oder nur ausgewählte Märkte gelten.

Einschränkungen

enum: ["all", "selected"]

Beispiel: "all"

nameZeichenfolgeErforderlich

Name der Ressource im jeweiligen Kontext.

Beispiel: "Example"

phrase_groupsArray <RulePhraseGroupData > Erforderlich

Gruppen von Suchregel-Phrasen.

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

product_idsArray <Zeichenfolge> Erforderlich

Kennungen der zugehörigen Produkte.

Beispiel: ["example"]

updated_atZeichenfolgeErforderlich

Zeitpunkt der letzten Änderung.

format: "date-time"

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

versionGanzzahlErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 1

Zusätzliche Felder: Nein

Gruppen von Suchregel-Phrasen

RulePhraseGroupData · Schema · Datenschemas: Suchanalysen und Regeln

localeZeichenfolgeErforderlich: Für diese Anfrage ausgewählte Sprache.

Beispiel: "en"
phrasesArray <Zeichenfolge> Erforderlich: Von der Suchregel verwendete Phrasen.

Beispiel: ["example"]

Zusätzliche Felder: Nein

Auflisten · Regeln — Suchanalysen und Regeln — Antwort

RuleSummaryData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

created_atZeichenfolgeErforderlich

Zeitpunkt der Erstellung.

format: "date-time"

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

enabledBoolescher WertErforderlich

Gibt an, ob diese Einstellung aktiviert ist.

Beispiel: true

idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen. (RuleSummaryData).

Beispiel: "example"

is_availableBoolescher WertErforderlich

Gibt an, ob der Artikel in diesem Kontext verfügbar ist.

Beispiel: true

market_scopeZeichenfolgeErforderlich

Gibt an, ob alle oder nur ausgewählte Märkte gelten.

Einschränkungen

enum: ["all", "selected"]

Beispiel: "all"

nameZeichenfolgeErforderlich

Name der Ressource im jeweiligen Kontext.

Beispiel: "Example"

updated_atZeichenfolgeErforderlich

Zeitpunkt der letzten Änderung.

format: "date-time"

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

versionGanzzahlErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 1

Zusätzliche Felder: Nein

Aktualisieren · Regeln — Suchanalysen und Regeln — Anfrageinhalt

RuleUpdate · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

category_idsArray <Zeichenfolge> Optional

Kennungen der zugehörigen Kategorien.

maxItems: 100

Array:minLength: 1maxLength: 63

enabledBoolescher WertOptional

Gibt an, ob diese Einstellung aktiviert ist.

expected_versionGanzzahlErforderlich

Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 1maximum: 2147483647

Beispiel: 1

market_idsArray <Zeichenfolge> Optional

Kennungen der ausgewählten Märkte.

maxItems: 1000

Array:minLength: 1maxLength: 63

market_scopeZeichenfolgeOptional

Gibt an, ob alle oder nur ausgewählte Märkte gelten.

Einschränkungen

enum: ["all", "selected"]

nameZeichenfolgeOptional

Name der Ressource im jeweiligen Kontext.

minLength: 1maxLength: 160

Beispiel: "Example"

phrasesArray <Zeichenfolge> Optional

Von der Suchregel verwendete Phrasen.

maxItems: 20

Array:minLength: 1maxLength: 255

product_idsArray <Zeichenfolge> Optional

Kennungen der zugehörigen Produkte.

maxItems: 100

Array:minLength: 1maxLength: 63

Zusätzliche Felder: Nein

Filter für Suchvorgänge mit oder ohne ergebnislose Vorkommnisse

ZeroResultScope · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

Zeichenfolge

Einschränkungen

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

Zusätzliche Felder: Ja