Schémas de données: Analyse des recherches et règles

Schémas de données: Analyse des recherches et règles. Champs, types et contraintes des données acceptées ou renvoyées par l’API.

Schémas de données

Métadonnées de la réponse

AnalyticsMeta · Schéma · Schémas de données: Analyse des recherches et règles

periodAnalyticsPeriodData Obligatoire: Période du rapport et ses bornes.

Exemple: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idChaîneObligatoire: Identifiant de demande ; dans les métadonnées, identifiant de la requête HTTP.

minLength: 1maxLength: 100

Exemple: "example"

Champs supplémentaires: Non

Période du rapport et ses bornes

AnalyticsPeriodData · Schéma · Schémas de données: Analyse des recherches et règles

as_ofChaîneObligatoire: Instant auquel les données présentées se rapportent.

format: "date-time"

Exemple: "2026-01-02T00:00:00Z"
daysEntierObligatoire: Période du rapport en jours.

Exemple: 1
started_atChaîneObligatoire: Date et heure de début.

format: "date-time"

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

Champs supplémentaires: Non

Lister · Requêtes — Analyse des recherches et règles — Réponse

AnalyticsResponse_list_MetricData__ · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

dataTableau <MetricData > Obligatoire: Exemple de réponse · AnalyticsResponse_list_MetricData__.

Exemple: [{"clicks":1,"last_seen_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","searches":1,"zero_results":1}]
metaAnalyticsPageMeta AnalyticsMeta Obligatoire: Métadonnées de la réponse.

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

Champs supplémentaires: Non

Obtenir · Requêtes — Analyse des recherches et règles — Réponse

AnalyticsResponse_list_OccurrenceData__ · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

dataTableau <OccurrenceData > Obligatoire: Exemple de réponse · AnalyticsResponse_list_OccurrenceData__.

Exemple: [{"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 Obligatoire: Métadonnées de la réponse.

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

Champs supplémentaires: Non

Résumé — Analyse des recherches et règles — Réponse

AnalyticsResponse_OverviewData_ · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

dataOverviewData Obligatoire: Exemple de réponse · OverviewData.

Exemple: {"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 Obligatoire: Métadonnées de la réponse.

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

Champs supplémentaires: Non

Lister · Règles — Analyse des recherches et règles — Réponse

ApiResponse_list_RuleSummaryData__ · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

dataTableau <RuleSummaryData > Obligatoire: Exemple de réponse · ApiResponse_list_RuleSummaryData__.

Exemple: [{"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 Obligatoire: Métadonnées de la réponse.

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

Champs supplémentaires: Non

Obtenir · Règles — Analyse des recherches et règles — Réponse

ApiResponse_RuleDetailData_ · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

dataRuleDetailData Obligatoire: Exemple de réponse · RuleDetailData.

Exemple: {"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 Obligatoire: Métadonnées de la réponse.

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

Champs supplémentaires: Non

Lister · Requêtes — Analyse des recherches et règles — Réponse

MetricData · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

clicksEntierObligatoire: Nombre de clics.

Exemple: 1
last_seen_atChaîneObligatoire: Date et heure de la dernière occurrence.

format: "date-time"

Exemple: "2026-01-01T12:00:00Z"
query_displayChaîneObligatoire: Expression recherchée affichée à l'administrateur.

Exemple: "example"
query_hashChaîneObligatoire: Identifiant stable de l'expression recherchée regroupée.

Exemple: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
searchesEntierObligatoire: Nombre de recherches.

Exemple: 1
zero_resultsEntierObligatoire: Nombre de recherches sans résultat.

Exemple: 1

Champs supplémentaires: Non

Obtenir · Requêtes — Analyse des recherches et règles — Réponse

OccurrenceData · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

category_idChaîne nullObligatoire

Identifiant de la catégorie.

Exemple: "example"

category_result_countEntierObligatoire

Nombre de résultats de catégorie.

Exemple: 1

currency_codeChaîneObligatoire

Code de la devise.

Exemple: "PLN"

is_zero_resultsBooléenObligatoire

Indique si la recherche n'a renvoyé aucun résultat.

Exemple: false

locale_codeChaîneObligatoire

Code de langue.

Exemple: "en"

market_idChaîneObligatoire

Identifiant de marché renvoyé par le point d'accès au contexte.

Exemple: "example"

max_priceChaîne nullObligatoire

Prix maximal dans la plage indiquée.

Exemple: "0.00"

min_priceChaîne nullObligatoire

Prix minimal dans la plage indiquée.

Exemple: "0.00"

occurred_atChaîneObligatoire

Date et heure de l'événement.

format: "date-time"

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

pageEntierObligatoire

Informations sur la page CMS.

Exemple: 1

product_result_countEntierObligatoire

Nombre de produits dans les résultats de recherche.

Exemple: 1

query_displayChaîneObligatoire

Expression recherchée affichée à l'administrateur.

Exemple: "example"

request_idChaîneObligatoire

Identifiant de demande ; dans les métadonnées, identifiant de la requête HTTP.

Exemple: "example"

resultsTableau <ResultSnapshotData > nullObligatoire

Résultats de recherche enregistrés.

Exemple:

[{"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_keyChaîneObligatoire

Clé de tri.

Exemple: "example"

sourceChaîneObligatoire

Source de l'activité enregistrée.

Contraintes

enum: ["results", "autocomplete"]

Exemple: "results"

Champs supplémentaires: Non

Résumé — Analyse des recherches et règles — Réponse

OverviewData · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

click_through_rateNombreObligatoire: Taux de clics pour les données de recherche sélectionnées.

Exemple: 0
clicked_searchesEntierObligatoire: Nombre de recherches ayant entraîné un clic.

Exemple: 1
recentTableau <RecentSearchData > Obligatoire: Informations sur les recherches récentes.

Exemple: [{"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"}]
searchesEntierObligatoire: Nombre de recherches.

Exemple: 1
zero_result_rateNombreObligatoire: Part des recherches n'ayant donné aucun résultat.

Exemple: 0
zero_resultsEntierObligatoire: Nombre de recherches sans résultat.

Exemple: 1

Champs supplémentaires: Non

Ordre de tri sélectionné pour les résultats

QueryMetricSort · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

Chaîne

Contraintes

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

Champs supplémentaires: Oui

Informations sur les recherches récentes

RecentSearchData · Schéma · Schémas de données: Analyse des recherches et règles

is_zero_resultsBooléenObligatoire

Indique si la recherche n'a renvoyé aucun résultat.

Exemple: false

locale_codeChaîneObligatoire

Code de langue.

Exemple: "en"

occurred_atChaîneObligatoire

Date et heure de l'événement.

format: "date-time"

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

query_displayChaîneObligatoire

Expression recherchée affichée à l'administrateur.

Exemple: "example"

query_hashChaîneObligatoire

Identifiant stable de l'expression recherchée regroupée.

Exemple: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idChaîneObligatoire

Identifiant de demande ; dans les métadonnées, identifiant de la requête HTTP.

Exemple: "example"

result_countEntierObligatoire

Nombre de résultats de recherche.

Exemple: 1

sourceChaîneObligatoire

Source de l'activité enregistrée.

Contraintes

enum: ["results", "autocomplete"]

Exemple: "results"

Champs supplémentaires: Non

Résultats de recherche enregistrés

ResultSnapshotData · Schéma · Schémas de données: Analyse des recherches et règles

clickedBooléenObligatoire

Indique si le résultat a reçu un clic.

Exemple: false

entity_idChaîneObligatoire

Identifiant de l'entité référencée.

Exemple: "example"

entity_typeChaîneObligatoire

Type de l'entité référencée.

Contraintes

enum: ["product", "category"]

Exemple: "product"

image_urlChaîne nullObligatoire

URL de l'image.

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

numberChaîne nullObligatoire

Numéro de commande ou de demande visible par l'utilisateur.

Exemple: "example"

placement_sourceChaîneObligatoire

Source de création de la commande.

Contraintes

enum: ["organic", "merchandising"]

Exemple: "organic"

positionEntierObligatoire

Position dans la collection ordonnée.

Exemple: 1

skuChaîneObligatoire

Code de l'unité de gestion des stocks.

Exemple: "example"

slugChaîneObligatoire

Segment du chemin URL dans la langue sélectionnée.

Exemple: "example"

titleChaîneObligatoire

Titre dans la langue sélectionnée.

Exemple: "example"

Champs supplémentaires: Non

Créer · Règles — Analyse des recherches et règles — Corps de la requête

RuleCreate · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

category_idsTableau <Chaîne> Facultatif

Identifiants des catégories associées.

maxItems: 100

Tableau:minLength: 1maxLength: 63

enabledBooléenFacultatif

Indique si ce paramètre est activé.

Valeur par défaut: false

market_idsTableau <Chaîne> Facultatif

Identifiants des marchés sélectionnés.

maxItems: 1000

Tableau:minLength: 1maxLength: 63

market_scopeChaîneFacultatif

Indique si la ressource concerne tous les marchés ou une sélection.

Contraintes

enum: ["all", "selected"]

nameChaîneObligatoire

Nom de la ressource dans le contexte concerné.

minLength: 1maxLength: 160

Exemple: "Example"

phrasesTableau <Chaîne> Obligatoire

Expressions utilisées par la règle de recherche.

minItems: 1maxItems: 20

Tableau:minLength: 1maxLength: 255

Exemple: ["example"]

product_idsTableau <Chaîne> Facultatif

Identifiants des produits associés.

maxItems: 100

Tableau:minLength: 1maxLength: 63

Exemple: ["example"]

Champs supplémentaires: Non

Obtenir · Règles — Analyse des recherches et règles — Réponse

RuleDetailData · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

category_idsTableau <Chaîne> Obligatoire

Identifiants des catégories associées.

Exemple: ["example"]

created_atChaîneObligatoire

Date et heure de création.

format: "date-time"

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

enabledBooléenObligatoire

Indique si ce paramètre est activé.

Exemple: true

idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée. (RuleDetailData).

Exemple: "example"

is_availableBooléenObligatoire

Indique si l'article est disponible dans ce contexte.

Exemple: true

market_idsTableau <Chaîne> Obligatoire

Identifiants des marchés sélectionnés.

Exemple: ["example"]

market_scopeChaîneObligatoire

Indique si la ressource concerne tous les marchés ou une sélection.

Contraintes

enum: ["all", "selected"]

Exemple: "all"

nameChaîneObligatoire

Nom de la ressource dans le contexte concerné.

Exemple: "Example"

phrase_groupsTableau <RulePhraseGroupData > Obligatoire

Groupes d'expressions d'une règle de recherche.

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

product_idsTableau <Chaîne> Obligatoire

Identifiants des produits associés.

Exemple: ["example"]

updated_atChaîneObligatoire

Date et heure de la dernière modification.

format: "date-time"

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

versionEntierObligatoire

Version de ressource utilisée pour le contrôle de concurrence.

Exemple: 1

Champs supplémentaires: Non

Groupes d'expressions d'une règle de recherche

RulePhraseGroupData · Schéma · Schémas de données: Analyse des recherches et règles

localeChaîneObligatoire: Langue sélectionnée pour cette requête.

Exemple: "en"
phrasesTableau <Chaîne> Obligatoire: Expressions utilisées par la règle de recherche.

Exemple: ["example"]

Champs supplémentaires: Non

Lister · Règles — Analyse des recherches et règles — Réponse

RuleSummaryData · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

created_atChaîneObligatoire

Date et heure de création.

format: "date-time"

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

enabledBooléenObligatoire

Indique si ce paramètre est activé.

Exemple: true

idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée. (RuleSummaryData).

Exemple: "example"

is_availableBooléenObligatoire

Indique si l'article est disponible dans ce contexte.

Exemple: true

market_scopeChaîneObligatoire

Indique si la ressource concerne tous les marchés ou une sélection.

Contraintes

enum: ["all", "selected"]

Exemple: "all"

nameChaîneObligatoire

Nom de la ressource dans le contexte concerné.

Exemple: "Example"

updated_atChaîneObligatoire

Date et heure de la dernière modification.

format: "date-time"

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

versionEntierObligatoire

Version de ressource utilisée pour le contrôle de concurrence.

Exemple: 1

Champs supplémentaires: Non

Modifier · Règles — Analyse des recherches et règles — Corps de la requête

RuleUpdate · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

category_idsTableau <Chaîne> Facultatif

Identifiants des catégories associées.

maxItems: 100

Tableau:minLength: 1maxLength: 63

enabledBooléenFacultatif

Indique si ce paramètre est activé.

expected_versionEntierObligatoire

Version lue avant l'écriture ; une différence entraîne le rejet de la modification.

minimum: 1maximum: 2147483647

Exemple: 1

market_idsTableau <Chaîne> Facultatif

Identifiants des marchés sélectionnés.

maxItems: 1000

Tableau:minLength: 1maxLength: 63

market_scopeChaîneFacultatif

Indique si la ressource concerne tous les marchés ou une sélection.

Contraintes

enum: ["all", "selected"]

nameChaîneFacultatif

Nom de la ressource dans le contexte concerné.

minLength: 1maxLength: 160

Exemple: "Example"

phrasesTableau <Chaîne> Facultatif

Expressions utilisées par la règle de recherche.

maxItems: 20

Tableau:minLength: 1maxLength: 255

product_idsTableau <Chaîne> Facultatif

Identifiants des produits associés.

maxItems: 100

Tableau:minLength: 1maxLength: 63

Champs supplémentaires: Non

Filtre des recherches avec ou sans occurrences sans résultat

ZeroResultScope · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

Chaîne

Contraintes

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

Champs supplémentaires: Oui