Схеми даних: Аналітика й правила пошуку

Схеми даних: Аналітика й правила пошуку. Поля, типи й обмеження даних, які API приймає або повертає.

Схеми даних

Метадані відповіді

AnalyticsMeta · Схема · Схеми даних: Аналітика й правила пошуку

periodAnalyticsPeriodData Обов’язкове: Звітний період і його межі.

Приклад: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idРядокОбов’язкове: Ідентифікатор звернення; у метаданих відповіді ідентифікує запит HTTP.

minLength: 1maxLength: 100

Приклад: "example"

Додаткові поля: Ні

Звітний період і його межі

AnalyticsPeriodData · Схема · Схеми даних: Аналітика й правила пошуку

as_ofРядокОбов’язкове: Момент часу, якого стосуються наведені дані.

format: "date-time"

Приклад: "2026-01-02T00:00:00Z"
daysЦіле числоОбов’язкове: Звітний період у днях.

Приклад: 1
started_atРядокОбов’язкове: Дата й час початку.

format: "date-time"

Приклад: "2026-01-01T00:00:00Z"

Додаткові поля: Ні

Отримати список · Пошукові запити — Аналітика й правила пошуку — Відповідь

AnalyticsResponse_list_MetricData__ · Поля, типи й обмеження даних, які API приймає або повертає.

dataМасив <MetricData > Обов’язкове: Приклад відповіді · AnalyticsResponse_list_MetricData__.

Приклад: [{"clicks":1,"last_seen_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","searches":1,"zero_results":1}]
metaAnalyticsPageMeta AnalyticsMeta Обов’язкове: Метадані відповіді.

Приклад: {"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"}

Додаткові поля: Ні

Отримати · Пошукові запити — Аналітика й правила пошуку — Відповідь

AnalyticsResponse_list_OccurrenceData__ · Поля, типи й обмеження даних, які API приймає або повертає.

dataМасив <OccurrenceData > Обов’язкове: Приклад відповіді · AnalyticsResponse_list_OccurrenceData__.

Приклад: [{"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 Обов’язкове: Метадані відповіді.

Приклад: {"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"}

Додаткові поля: Ні

Підсумок — Аналітика й правила пошуку — Відповідь

AnalyticsResponse_OverviewData_ · Поля, типи й обмеження даних, які API приймає або повертає.

dataOverviewData Обов’язкове: Приклад відповіді · OverviewData.

Приклад: {"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 Обов’язкове: Метадані відповіді.

Приклад: {"period":{"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"},"request_id":"example"}

Додаткові поля: Ні

Отримати список · Правила — Аналітика й правила пошуку — Відповідь

ApiResponse_list_RuleSummaryData__ · Поля, типи й обмеження даних, які API приймає або повертає.

dataМасив <RuleSummaryData > Обов’язкове: Приклад відповіді · ApiResponse_list_RuleSummaryData__.

Приклад: [{"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 Обов’язкове: Метадані відповіді.

Приклад: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Додаткові поля: Ні

Отримати · Правила — Аналітика й правила пошуку — Відповідь

ApiResponse_RuleDetailData_ · Поля, типи й обмеження даних, які API приймає або повертає.

dataRuleDetailData Обов’язкове: Приклад відповіді · RuleDetailData.

Приклад: {"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 Обов’язкове: Метадані відповіді.

Приклад: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Додаткові поля: Ні

Отримати список · Пошукові запити — Аналітика й правила пошуку — Відповідь

MetricData · Поля, типи й обмеження даних, які API приймає або повертає.

clicksЦіле числоОбов’язкове: Кількість натискань.

Приклад: 1
last_seen_atРядокОбов’язкове: Час останньої появи.

format: "date-time"

Приклад: "2026-01-01T12:00:00Z"
query_displayРядокОбов’язкове: Пошукова фраза, показана адміністратору.

Приклад: "example"
query_hashРядокОбов’язкове: Стабільний ідентифікатор згрупованої пошукової фрази.

Приклад: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
searchesЦіле числоОбов’язкове: Кількість пошуків.

Приклад: 1
zero_resultsЦіле числоОбов’язкове: Кількість пошуків без результатів.

Приклад: 1

Додаткові поля: Ні

Отримати · Пошукові запити — Аналітика й правила пошуку — Відповідь

OccurrenceData · Поля, типи й обмеження даних, які API приймає або повертає.

category_idРядок nullОбов’язкове

Ідентифікатор категорії.

Приклад: "example"

category_result_countЦіле числоОбов’язкове

Кількість результатів категорій.

Приклад: 1

currency_codeРядокОбов’язкове

Код валюти.

Приклад: "PLN"

is_zero_resultsЛогічне значенняОбов’язкове

Чи не повернув пошук жодного результату.

Приклад: false

locale_codeРядокОбов’язкове

Код мови.

Приклад: "en"

market_idРядокОбов’язкове

Ідентифікатор ринку, повернутий кінцевою точкою контексту.

Приклад: "example"

max_priceРядок nullОбов’язкове

Максимальна ціна в наведеному діапазоні.

Приклад: "0.00"

min_priceРядок nullОбов’язкове

Мінімальна ціна в наведеному діапазоні.

Приклад: "0.00"

occurred_atРядокОбов’язкове

Дата й час події.

format: "date-time"

Приклад: "2026-01-01T12:00:00Z"

pageЦіле числоОбов’язкове

Відомості про сторінку CMS.

Приклад: 1

product_result_countЦіле числоОбов’язкове

Кількість товарів у результатах пошуку.

Приклад: 1

query_displayРядокОбов’язкове

Пошукова фраза, показана адміністратору.

Приклад: "example"

request_idРядокОбов’язкове

Ідентифікатор звернення; у метаданих відповіді ідентифікує запит HTTP.

Приклад: "example"

resultsМасив <ResultSnapshotData > nullОбов’язкове

Записані результати пошуку.

Приклад:

[{"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РядокОбов’язкове

Джерело записаної активності.

Обмеження

enum: ["results", "autocomplete"]

Приклад: "results"

Додаткові поля: Ні

Підсумок — Аналітика й правила пошуку — Відповідь

OverviewData · Поля, типи й обмеження даних, які API приймає або повертає.

click_through_rateЧислоОбов’язкове: Частка переходів для вибраних пошукових даних.

Приклад: 0
clicked_searchesЦіле числоОбов’язкове: Кількість пошуків із переходом за результатом.

Приклад: 1
recentМасив <RecentSearchData > Обов’язкове: Відомості про останні пошуки.

Приклад: [{"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

Додаткові поля: Ні

Вибраний порядок сортування результатів

QueryMetricSort · Поля, типи й обмеження даних, які API приймає або повертає.

Рядок

Обмеження

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

Додаткові поля: Так

Відомості про останні пошуки

RecentSearchData · Схема · Схеми даних: Аналітика й правила пошуку

is_zero_resultsЛогічне значенняОбов’язкове

Чи не повернув пошук жодного результату.

Приклад: false

locale_codeРядокОбов’язкове

Код мови.

Приклад: "en"

occurred_atРядокОбов’язкове

Дата й час події.

format: "date-time"

Приклад: "2026-01-01T12:00:00Z"

query_displayРядокОбов’язкове

Пошукова фраза, показана адміністратору.

Приклад: "example"

query_hashРядокОбов’язкове

Стабільний ідентифікатор згрупованої пошукової фрази.

Приклад: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idРядокОбов’язкове

Ідентифікатор звернення; у метаданих відповіді ідентифікує запит HTTP.

Приклад: "example"

result_countЦіле числоОбов’язкове

Кількість результатів пошуку.

Приклад: 1

sourceРядокОбов’язкове

Джерело записаної активності.

Обмеження

enum: ["results", "autocomplete"]

Приклад: "results"

Додаткові поля: Ні

Записані результати пошуку

ResultSnapshotData · Схема · Схеми даних: Аналітика й правила пошуку

clickedЛогічне значенняОбов’язкове

Чи було натиснуто результат.

Приклад: false

entity_idРядокОбов’язкове

Ідентифікатор сутності, на яку є посилання.

Приклад: "example"

entity_typeРядокОбов’язкове

Тип сутності, на яку є посилання.

Обмеження

enum: ["product", "category"]

Приклад: "product"

image_urlРядок nullОбов’язкове

URL зображення.

Приклад: "https://example.invalid/product.jpg"

numberРядок nullОбов’язкове

Зрозумілий користувачу номер замовлення або звернення.

Приклад: "example"

placement_sourceРядокОбов’язкове

Джерело оформлення замовлення.

Обмеження

enum: ["organic", "merchandising"]

Приклад: "organic"

positionЦіле числоОбов’язкове

Позиція у впорядкованому списку.

Приклад: 1

skuРядокОбов’язкове

Код складської облікової одиниці.

Приклад: "example"

slugРядокОбов’язкове

Сегмент шляху URL вибраною мовою.

Приклад: "example"

titleРядокОбов’язкове

Заголовок вибраною мовою.

Приклад: "example"

Додаткові поля: Ні

Створити · Правила — Аналітика й правила пошуку — Тіло запиту

RuleCreate · Поля, типи й обмеження даних, які API приймає або повертає.

category_idsМасив <Рядок> Необов’язкове

Ідентифікатори пов’язаних категорій.

maxItems: 100

Масив:minLength: 1maxLength: 63

enabledЛогічне значенняНеобов’язкове

Чи ввімкнено це налаштування.

За замовчуванням: false

market_idsМасив <Рядок> Необов’язкове

Ідентифікатори вибраних ринків.

maxItems: 1000

Масив:minLength: 1maxLength: 63

market_scopeРядокНеобов’язкове

Чи поширюється ресурс на всі ринки або лише вибрані.

Обмеження

enum: ["all", "selected"]

nameРядокОбов’язкове

Назва ресурсу у відповідному контексті.

minLength: 1maxLength: 160

Приклад: "Example"

phrasesМасив <Рядок> Обов’язкове

Фрази, які використовує правило пошуку.

minItems: 1maxItems: 20

Масив:minLength: 1maxLength: 255

Приклад: ["example"]

product_idsМасив <Рядок> Необов’язкове

Ідентифікатори пов’язаних товарів.

maxItems: 100

Масив:minLength: 1maxLength: 63

Приклад: ["example"]

Додаткові поля: Ні

Отримати · Правила — Аналітика й правила пошуку — Відповідь

RuleDetailData · Поля, типи й обмеження даних, які API приймає або повертає.

category_idsМасив <Рядок> Обов’язкове

Ідентифікатори пов’язаних категорій.

Приклад: ["example"]

created_atРядокОбов’язкове

Час створення.

format: "date-time"

Приклад: "2026-01-01T12:00:00Z"

enabledЛогічне значенняОбов’язкове

Чи ввімкнено це налаштування.

Приклад: true

idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді. (RuleDetailData).

Приклад: "example"

is_availableЛогічне значенняОбов’язкове

Чи доступна позиція в цьому контексті.

Приклад: true

market_idsМасив <Рядок> Обов’язкове

Ідентифікатори вибраних ринків.

Приклад: ["example"]

market_scopeРядокОбов’язкове

Чи поширюється ресурс на всі ринки або лише вибрані.

Обмеження

enum: ["all", "selected"]

Приклад: "all"

nameРядокОбов’язкове

Назва ресурсу у відповідному контексті.

Приклад: "Example"

phrase_groupsМасив <RulePhraseGroupData > Обов’язкове

Групи фраз правила пошуку.

Приклад: [{"locale":"en","phrases":["example"]}]

product_idsМасив <Рядок> Обов’язкове

Ідентифікатори пов’язаних товарів.

Приклад: ["example"]

updated_atРядокОбов’язкове

Час останнього оновлення.

format: "date-time"

Приклад: "2026-01-01T12:00:00Z"

versionЦіле числоОбов’язкове

Версія ресурсу для контролю одночасних змін.

Приклад: 1

Додаткові поля: Ні

Групи фраз правила пошуку

RulePhraseGroupData · Схема · Схеми даних: Аналітика й правила пошуку

localeРядокОбов’язкове: Мова, вибрана для цього запиту.

Приклад: "en"
phrasesМасив <Рядок> Обов’язкове: Фрази, які використовує правило пошуку.

Приклад: ["example"]

Додаткові поля: Ні

Отримати список · Правила — Аналітика й правила пошуку — Відповідь

RuleSummaryData · Поля, типи й обмеження даних, які API приймає або повертає.

created_atРядокОбов’язкове

Час створення.

format: "date-time"

Приклад: "2026-01-01T12:00:00Z"

enabledЛогічне значенняОбов’язкове

Чи ввімкнено це налаштування.

Приклад: true

idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді. (RuleSummaryData).

Приклад: "example"

is_availableЛогічне значенняОбов’язкове

Чи доступна позиція в цьому контексті.

Приклад: true

market_scopeРядокОбов’язкове

Чи поширюється ресурс на всі ринки або лише вибрані.

Обмеження

enum: ["all", "selected"]

Приклад: "all"

nameРядокОбов’язкове

Назва ресурсу у відповідному контексті.

Приклад: "Example"

updated_atРядокОбов’язкове

Час останнього оновлення.

format: "date-time"

Приклад: "2026-01-01T12:00:00Z"

versionЦіле числоОбов’язкове

Версія ресурсу для контролю одночасних змін.

Приклад: 1

Додаткові поля: Ні

Оновити · Правила — Аналітика й правила пошуку — Тіло запиту

RuleUpdate · Поля, типи й обмеження даних, які API приймає або повертає.

category_idsМасив <Рядок> Необов’язкове

Ідентифікатори пов’язаних категорій.

maxItems: 100

Масив:minLength: 1maxLength: 63

enabledЛогічне значенняНеобов’язкове

Чи ввімкнено це налаштування.

expected_versionЦіле числоОбов’язкове

Версія, прочитана перед записом; невідповідність блокує оновлення.

minimum: 1maximum: 2147483647

Приклад: 1

market_idsМасив <Рядок> Необов’язкове

Ідентифікатори вибраних ринків.

maxItems: 1000

Масив:minLength: 1maxLength: 63

market_scopeРядокНеобов’язкове

Чи поширюється ресурс на всі ринки або лише вибрані.

Обмеження

enum: ["all", "selected"]

nameРядокНеобов’язкове

Назва ресурсу у відповідному контексті.

minLength: 1maxLength: 160

Приклад: "Example"

phrasesМасив <Рядок> Необов’язкове

Фрази, які використовує правило пошуку.

maxItems: 20

Масив:minLength: 1maxLength: 255

product_idsМасив <Рядок> Необов’язкове

Ідентифікатори пов’язаних товарів.

maxItems: 100

Масив:minLength: 1maxLength: 63

Додаткові поля: Ні

Фільтр пошуків із появами без результатів або без таких появ

ZeroResultScope · Поля, типи й обмеження даних, які API приймає або повертає.

Рядок

Обмеження

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

Додаткові поля: Так