Get data analysis by search keyword

POST 
/openapi/2026-01/data-analysis/search-keyword

Retrieve on-site search analytics grouped by search keyword, including the number of searches, the number of searching users, whether the search returned results, and the click-through rate.

Request

application/json

Body

Bodyrequired

begin_timestringrequired

Start time, a Unix timestamp in seconds passed as a string, e.g. "1748736000"

end_timestringrequired

End time, a Unix timestamp in seconds passed as a string, e.g. "1781481600". Should be greater than begin_time

time_zoneint32

Notice: Values outside the range -12 to 14 might lead to unexpected results in time-based calculations. Time zone offset (in hours) used for analysis. Recommended range: -12 to 14

cursorstring

Cursor for pagination

page_sizeint32
Page size for pagination
Default value: 10
keywordstring

Fuzzy match on the search keyword

sort_bystring
Field to sort by. Supported values:
• count: Number of searches
• percent: Share of all searches
• uv: Number of searching users
• has_result: Whether the search returned results
• click_rate: Search click-through rate
sort_directionstring

Sorting direction: asc (ascending) or desc (descending). Defaults to desc

has_resultstring

Filter by whether the search returned results: 1 with results, 0 without results. Defaults to no filtering

country_codestring

Filter by the visitor's country/region code, e.g. "US"

filter_crawler_typestring
Crawler-filtering policy that controls whether bot/crawler traffic is excluded from the statistics. Values:
• no_filter_crawler: do not filter; count all traffic (default)
• official_crawler: exclude known crawlers/bots

Example

{
  "begin_time": "string",
  "end_time": "string",
  "time_zone": 0,
  "cursor": "string",
  "page_size": 10,
  "keyword": "string",
  "sort_by": "string",
  "sort_direction": "string",
  "has_result": "string",
  "country_code": "string",
  "filter_crawler_type": "string"
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object
countint32
Total number of matching search keywords
cursorstring
Cursor for pagination
has_moreboolean
Whether there are more records
data object[]
List of search keyword report rows
Array [
itemstring
The search keyword, e.g. "shoes"
countint64
Number of searches for this keyword
percentdouble
Share of this keyword in all searches, in percent, e.g. 12.34 (represents 12.34%)
uvint64
Number of users who searched for this keyword, deduplicated by IP
has_resultint32
Whether the search returned results: 1 yes, 0 no. A keyword with no results but with click-through is counted as 1
click_ratedouble
Search click-through rate, in percent (0 ~ 100), e.g. 35.71 (represents 35.71%)
]

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "count": 0,
    "cursor": "string",
    "has_more": true,
    "data": [
      {
        "item": "string",
        "count": 0,
        "percent": 0,
        "uv": 0,
        "has_result": 0,
        "click_rate": 0
      }
    ]
  }
}