Gegevensschema’s: Zoekanalyses en regels

Gegevensschema’s: Zoekanalyses en regels. Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

Gegevensschema’s

Metadata van het antwoord

AnalyticsMeta · Schema · Gegevensschema’s: Zoekanalyses en regels

periodAnalyticsPeriodData Verplicht: Rapportageperiode en de grenzen ervan.

Voorbeeld: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idTekenreeksVerplicht: Aanvraagidentificatie; in antwoordmetadata identificeert dit het HTTP-verzoek.

minLength: 1maxLength: 100

Voorbeeld: "example"

Aanvullende velden: Nee

Rapportageperiode en de grenzen ervan

AnalyticsPeriodData · Schema · Gegevensschema’s: Zoekanalyses en regels

as_ofTekenreeksVerplicht: Tijdstip waarop de gerapporteerde gegevens betrekking hebben.

format: "date-time"

Voorbeeld: "2026-01-02T00:00:00Z"
daysGeheel getalVerplicht: Rapportageperiode in dagen.

Voorbeeld: 1
started_atTekenreeksVerplicht: Begindatum en -tijd.

format: "date-time"

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

Aanvullende velden: Nee

Lijst ophalen · Zoekopdrachten — Zoekanalyses en regels — Antwoord

AnalyticsResponse_list_MetricData__ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

dataArray <MetricData > Verplicht: Voorbeeldantwoord · AnalyticsResponse_list_MetricData__.

Voorbeeld: [{"clicks":1,"last_seen_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","searches":1,"zero_results":1}]
metaAnalyticsPageMeta AnalyticsMeta Verplicht: Metadata van het antwoord.

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

Aanvullende velden: Nee

Ophalen · Zoekopdrachten — Zoekanalyses en regels — Antwoord

AnalyticsResponse_list_OccurrenceData__ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

dataArray <OccurrenceData > Verplicht: Voorbeeldantwoord · AnalyticsResponse_list_OccurrenceData__.

Voorbeeld: [{"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 Verplicht: Metadata van het antwoord.

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

Aanvullende velden: Nee

Samenvatting — Zoekanalyses en regels — Antwoord

AnalyticsResponse_OverviewData_ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

dataOverviewData Verplicht: Voorbeeldantwoord · OverviewData.

Voorbeeld: {"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 Verplicht: Metadata van het antwoord.

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

Aanvullende velden: Nee

Lijst ophalen · Regels — Zoekanalyses en regels — Antwoord

ApiResponse_list_RuleSummaryData__ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

dataArray <RuleSummaryData > Verplicht: Voorbeeldantwoord · ApiResponse_list_RuleSummaryData__.

Voorbeeld: [{"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 Verplicht: Metadata van het antwoord.

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

Aanvullende velden: Nee

Ophalen · Regels — Zoekanalyses en regels — Antwoord

ApiResponse_RuleDetailData_ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

dataRuleDetailData Verplicht: Voorbeeldantwoord · RuleDetailData.

Voorbeeld: {"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 Verplicht: Metadata van het antwoord.

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

Aanvullende velden: Nee

Lijst ophalen · Zoekopdrachten — Zoekanalyses en regels — Antwoord

MetricData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

clicksGeheel getalVerplicht: Aantal klikken.

Voorbeeld: 1
last_seen_atTekenreeksVerplicht: Tijdstip van de meest recente waarneming.

format: "date-time"

Voorbeeld: "2026-01-01T12:00:00Z"
query_displayTekenreeksVerplicht: Zoekterm die aan een beheerder wordt getoond.

Voorbeeld: "example"
query_hashTekenreeksVerplicht: Stabiele identificatie van de gegroepeerde zoekterm.

Voorbeeld: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
searchesGeheel getalVerplicht: Aantal zoekopdrachten.

Voorbeeld: 1
zero_resultsGeheel getalVerplicht: Aantal zoekopdrachten zonder resultaten.

Voorbeeld: 1

Aanvullende velden: Nee

Ophalen · Zoekopdrachten — Zoekanalyses en regels — Antwoord

OccurrenceData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

category_idTekenreeks nullVerplicht

Categorie-identificatie.

Voorbeeld: "example"

category_result_countGeheel getalVerplicht

Aantal categorieresultaten.

Voorbeeld: 1

currency_codeTekenreeksVerplicht

Valutacode.

Voorbeeld: "PLN"

is_zero_resultsBooleaanse waardeVerplicht

Of de zoekopdracht geen resultaten opleverde.

Voorbeeld: false

locale_codeTekenreeksVerplicht

Taalcode.

Voorbeeld: "en"

market_idTekenreeksVerplicht

Marktidentificatie die het contextendpoint teruggeeft.

Voorbeeld: "example"

max_priceTekenreeks nullVerplicht

Hoogste prijs in het gerapporteerde bereik.

Voorbeeld: "0.00"

min_priceTekenreeks nullVerplicht

Laagste prijs in het gerapporteerde bereik.

Voorbeeld: "0.00"

occurred_atTekenreeksVerplicht

Datum en tijd van de gebeurtenis.

format: "date-time"

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

pageGeheel getalVerplicht

Gegevens van de CMS-pagina.

Voorbeeld: 1

product_result_countGeheel getalVerplicht

Aantal productzoekresultaten.

Voorbeeld: 1

query_displayTekenreeksVerplicht

Zoekterm die aan een beheerder wordt getoond.

Voorbeeld: "example"

request_idTekenreeksVerplicht

Aanvraagidentificatie; in antwoordmetadata identificeert dit het HTTP-verzoek.

Voorbeeld: "example"

resultsArray <ResultSnapshotData > nullVerplicht

Vastgelegde zoekresultaten.

Voorbeeld:

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

Sorteersleutel.

Voorbeeld: "example"

sourceTekenreeksVerplicht

Bron van de vastgelegde activiteit.

Beperkingen

enum: ["results", "autocomplete"]

Voorbeeld: "results"

Aanvullende velden: Nee

Samenvatting — Zoekanalyses en regels — Antwoord

OverviewData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

click_through_rateGetalVerplicht: Doorklikpercentage voor de geselecteerde zoekgegevens.

Voorbeeld: 0
clicked_searchesGeheel getalVerplicht: Aantal zoekopdrachten met een klik.

Voorbeeld: 1
recentArray <RecentSearchData > Verplicht: Informatie over recente zoekopdrachten.

Voorbeeld: [{"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"}]
searchesGeheel getalVerplicht: Aantal zoekopdrachten.

Voorbeeld: 1
zero_result_rateGetalVerplicht: Aandeel zoekopdrachten zonder resultaten.

Voorbeeld: 0
zero_resultsGeheel getalVerplicht: Aantal zoekopdrachten zonder resultaten.

Voorbeeld: 1

Aanvullende velden: Nee

Geselecteerde sorteervolgorde voor de resultaten

QueryMetricSort · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

Tekenreeks

Beperkingen

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

Aanvullende velden: Ja

Informatie over recente zoekopdrachten

RecentSearchData · Schema · Gegevensschema’s: Zoekanalyses en regels

is_zero_resultsBooleaanse waardeVerplicht

Of de zoekopdracht geen resultaten opleverde.

Voorbeeld: false

locale_codeTekenreeksVerplicht

Taalcode.

Voorbeeld: "en"

occurred_atTekenreeksVerplicht

Datum en tijd van de gebeurtenis.

format: "date-time"

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

query_displayTekenreeksVerplicht

Zoekterm die aan een beheerder wordt getoond.

Voorbeeld: "example"

query_hashTekenreeksVerplicht

Stabiele identificatie van de gegroepeerde zoekterm.

Voorbeeld: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idTekenreeksVerplicht

Aanvraagidentificatie; in antwoordmetadata identificeert dit het HTTP-verzoek.

Voorbeeld: "example"

result_countGeheel getalVerplicht

Aantal zoekresultaten.

Voorbeeld: 1

sourceTekenreeksVerplicht

Bron van de vastgelegde activiteit.

Beperkingen

enum: ["results", "autocomplete"]

Voorbeeld: "results"

Aanvullende velden: Nee

Vastgelegde zoekresultaten

ResultSnapshotData · Schema · Gegevensschema’s: Zoekanalyses en regels

clickedBooleaanse waardeVerplicht

Of op het resultaat is geklikt.

Voorbeeld: false

entity_idTekenreeksVerplicht

Identificatie van de entiteit waarnaar wordt verwezen.

Voorbeeld: "example"

entity_typeTekenreeksVerplicht

Type van de entiteit waarnaar wordt verwezen.

Beperkingen

enum: ["product", "category"]

Voorbeeld: "product"

image_urlTekenreeks nullVerplicht

Afbeeldings-URL.

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

numberTekenreeks nullVerplicht

Bestel- of aanvraagnummer voor menselijk gebruik.

Voorbeeld: "example"

placement_sourceTekenreeksVerplicht

Bron van waaruit de bestelling is geplaatst.

Beperkingen

enum: ["organic", "merchandising"]

Voorbeeld: "organic"

positionGeheel getalVerplicht

Positie in de geordende verzameling.

Voorbeeld: 1

skuTekenreeksVerplicht

Voorraadartikelcode (SKU).

Voorbeeld: "example"

slugTekenreeksVerplicht

URL-padsegment in de geselecteerde taal.

Voorbeeld: "example"

titleTekenreeksVerplicht

Titel in de geselecteerde taal.

Voorbeeld: "example"

Aanvullende velden: Nee

Aanmaken · Regels — Zoekanalyses en regels — Verzoekinhoud

RuleCreate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

category_idsArray <Tekenreeks> Optioneel

Identificaties van gerelateerde categorieën.

maxItems: 100

Array:minLength: 1maxLength: 63

enabledBooleaanse waardeOptioneel

Of deze instelling is ingeschakeld.

Standaard: false

market_idsArray <Tekenreeks> Optioneel

Identificaties van geselecteerde markten.

maxItems: 1000

Array:minLength: 1maxLength: 63

market_scopeTekenreeksOptioneel

Of de resource voor alle of alleen geselecteerde markten geldt.

Beperkingen

enum: ["all", "selected"]

nameTekenreeksVerplicht

Resourcenaam in de betreffende context.

minLength: 1maxLength: 160

Voorbeeld: "Example"

phrasesArray <Tekenreeks> Verplicht

Zoektermen die de zoekregel gebruikt.

minItems: 1maxItems: 20

Array:minLength: 1maxLength: 255

Voorbeeld: ["example"]

product_idsArray <Tekenreeks> Optioneel

Identificaties van gerelateerde producten.

maxItems: 100

Array:minLength: 1maxLength: 63

Voorbeeld: ["example"]

Aanvullende velden: Nee

Ophalen · Regels — Zoekanalyses en regels — Antwoord

RuleDetailData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

category_idsArray <Tekenreeks> Verplicht

Identificaties van gerelateerde categorieën.

Voorbeeld: ["example"]

created_atTekenreeksVerplicht

Tijdstip van aanmaak.

format: "date-time"

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

enabledBooleaanse waardeVerplicht

Of deze instelling is ingeschakeld.

Voorbeeld: true

idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven. (RuleDetailData).

Voorbeeld: "example"

is_availableBooleaanse waardeVerplicht

Of het item beschikbaar is in deze context.

Voorbeeld: true

market_idsArray <Tekenreeks> Verplicht

Identificaties van geselecteerde markten.

Voorbeeld: ["example"]

market_scopeTekenreeksVerplicht

Of de resource voor alle of alleen geselecteerde markten geldt.

Beperkingen

enum: ["all", "selected"]

Voorbeeld: "all"

nameTekenreeksVerplicht

Resourcenaam in de betreffende context.

Voorbeeld: "Example"

phrase_groupsArray <RulePhraseGroupData > Verplicht

Groepen zoektermen van de zoekregel.

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

product_idsArray <Tekenreeks> Verplicht

Identificaties van gerelateerde producten.

Voorbeeld: ["example"]

updated_atTekenreeksVerplicht

Tijdstip van de meest recente wijziging.

format: "date-time"

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

versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

Aanvullende velden: Nee

Groepen zoektermen van de zoekregel

RulePhraseGroupData · Schema · Gegevensschema’s: Zoekanalyses en regels

localeTekenreeksVerplicht: Taal die voor dit verzoek is geselecteerd.

Voorbeeld: "en"
phrasesArray <Tekenreeks> Verplicht: Zoektermen die de zoekregel gebruikt.

Voorbeeld: ["example"]

Aanvullende velden: Nee

Lijst ophalen · Regels — Zoekanalyses en regels — Antwoord

RuleSummaryData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

created_atTekenreeksVerplicht

Tijdstip van aanmaak.

format: "date-time"

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

enabledBooleaanse waardeVerplicht

Of deze instelling is ingeschakeld.

Voorbeeld: true

idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven. (RuleSummaryData).

Voorbeeld: "example"

is_availableBooleaanse waardeVerplicht

Of het item beschikbaar is in deze context.

Voorbeeld: true

market_scopeTekenreeksVerplicht

Of de resource voor alle of alleen geselecteerde markten geldt.

Beperkingen

enum: ["all", "selected"]

Voorbeeld: "all"

nameTekenreeksVerplicht

Resourcenaam in de betreffende context.

Voorbeeld: "Example"

updated_atTekenreeksVerplicht

Tijdstip van de meest recente wijziging.

format: "date-time"

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

versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

Aanvullende velden: Nee

Bijwerken · Regels — Zoekanalyses en regels — Verzoekinhoud

RuleUpdate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

category_idsArray <Tekenreeks> Optioneel

Identificaties van gerelateerde categorieën.

maxItems: 100

Array:minLength: 1maxLength: 63

enabledBooleaanse waardeOptioneel

Of deze instelling is ingeschakeld.

expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 1maximum: 2147483647

Voorbeeld: 1

market_idsArray <Tekenreeks> Optioneel

Identificaties van geselecteerde markten.

maxItems: 1000

Array:minLength: 1maxLength: 63

market_scopeTekenreeksOptioneel

Of de resource voor alle of alleen geselecteerde markten geldt.

Beperkingen

enum: ["all", "selected"]

nameTekenreeksOptioneel

Resourcenaam in de betreffende context.

minLength: 1maxLength: 160

Voorbeeld: "Example"

phrasesArray <Tekenreeks> Optioneel

Zoektermen die de zoekregel gebruikt.

maxItems: 20

Array:minLength: 1maxLength: 255

product_idsArray <Tekenreeks> Optioneel

Identificaties van gerelateerde producten.

maxItems: 100

Array:minLength: 1maxLength: 63

Aanvullende velden: Nee

Filter voor zoekopdrachten met of zonder zoekmomenten zonder resultaat

ZeroResultScope · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

Tekenreeks

Beperkingen

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

Aanvullende velden: Ja