概覽 — 搜尋分析與規則
讀取「搜尋分析與規則」的資料。結果取決於此操作的參數。
GET
/api/v1/search/overviewcURL 請求
curl --disable --globoff --fail-with-body --silent --show-error \
--proto '=https' --connect-timeout 5 --max-time 30 \
--request GET \
--url https://shop.onshopently.com/api/v1/search/overview \
--header 'Authorization: Bearer EXAMPLE_ACCESS_TOKEN'
回應
{
"data": {
"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
},
"meta": {
"period": {
"as_of": "2026-01-02T00:00:00Z",
"days": 1,
"started_at": "2026-01-01T00:00:00Z"
},
"request_id": "example"
}
}