跳至内容
ShopentlyLearn
简体中文

数据架构: 搜索分析与规则

数据架构: 搜索分析与规则. 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"]

附加字段: 是