Схеми на данните: Анализи и правила за търсене

Схеми на данните: Анализи и правила за търсене. Полета, типове и ограничения на данните, приемани или връщани от 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НизЗадължително

Идентификатор на пазара, върнат от endpoint за контекст.

Пример: "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"]

Допълнителни полета: Да