資料架構: 搜尋分析與規則

資料架構: 搜尋分析與規則. 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"]

附加欄位: 是

記錄的搜尋結果

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字串必填

搜尋規則的短語組

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字串必填

更新 · 規則 — 搜尋分析與規則 — 請求本文

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"]

附加欄位: 是

回應元資料

報告期及其邊界

取得清單 · 搜尋查詢 — 搜尋分析與規則 — 回應

取得 · 搜尋查詢 — 搜尋分析與規則 — 回應

概覽 — 搜尋分析與規則 — 回應

取得清單 · 規則 — 搜尋分析與規則 — 回應

取得 · 規則 — 搜尋分析與規則 — 回應

取得清單 · 搜尋查詢 — 搜尋分析與規則 — 回應

取得 · 搜尋查詢 — 搜尋分析與規則 — 回應

概覽 — 搜尋分析與規則 — 回應

為結果選擇的排序方式

最近搜尋資訊

記錄的搜尋結果

建立 · 規則 — 搜尋分析與規則 — 請求本文

取得 · 規則 — 搜尋分析與規則 — 回應

搜尋規則的短語組

取得清單 · 規則 — 搜尋分析與規則 — 回應

更新 · 規則 — 搜尋分析與規則 — 請求本文

按是否存在零結果記錄篩選搜尋