https://api.nexscope.ai/sr/ozon/keywordMiningRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/sr/ozon/keywordMining |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
keyword | string | required | Seed keyword, maximum length 1000. |
page | object | required | Paging and sorting: `{page, pageSize, orders[]}`. |
page.page | integer | optional | Page number, starting from 1. Example: 1 |
page.pageSize | integer | optional | Number of items per page. Example: 20 |
page.orders | array | optional | Sorting rule, the element is `{field, direction}`; `direction` takes `DESC` or `ASC`. |
matchType | integer | optional | Keyword matching mode: `0` precise, `1` fuzzy. |
includeKeywords | string[] | optional | Contains an array of keywords, up to 1000. |
excludeKeywords | string[] | optional | Array of excluded keywords, up to 1000. |
wordCount | object | optional | Keyword word range. |
searchVolume | object | optional | Search popularity range. |
searchChange30 | object | optional | 30-day search range. |
productViews | object | optional | Product view range. |
products | object | optional | Product number range. |
sellers | object | optional | Number of sellers range. |
price | object | optional | Price range. |
marketSpace | object | optional | Market space scope. |
conversionSharing | object | optional | Conversion concentration range. |
relevancy | object | optional | Relevance range to seed words. |
uniqQueriesWCa | object | optional | The range of additional purchases. |
ca | object | optional | Add-on conversion rate range. |
titleDensity | object | optional | Title density range. |
adRivalCount | object | optional | The range of the number of advertising competing products. |
uId | string | optional | User ID. |
memberId | string | optional | Member ID; the data is attributed to this member. |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
No response example is published for this API. Refer to the response fields below.
Response fields
Response field reference (46 fields)
| Name | Type | Required | Description |
|---|---|---|---|
code | string | optional | Return code, `"200"` indicates success; returned when successful. |
errcode | integer | optional | Error code, `200` indicates success; only this field may be returned when there is a business error. |
msg | string | optional | Message; Success was `ok`. |
errmsg | string | optional | Error message; success is `ok`, business error is a reason description. |
total | integer | optional | Total number of records. |
data | array | optional | Keyword mining data, element fields are shown in the table below. |
columns | array | optional | Column definition, elements containing `field`, `title`, `cellType`, `sortable`, `filterable`. |
costTime | integer | optional | The interface consumes time in milliseconds. |
costToken | integer | optional | The number of tokens consumed. |
type | string | optional | Response display type, such as `tableListWorkbenches`. |
query | string | optional | Keywords, original Russian text. |
queryCn | string | optional | Keywords Chinese translation. |
platform | integer | optional | Platform: `0` Ozon, `1` Wildberries. |
searchVolume | integer | optional | Monthly search popularity. |
count30GrowthRate | number | optional | Monthly search growth, percentage, can be negative. |
productCount | integer | optional | Number of items, some rows may be missing. |
competingProducts | integer | optional | Number of competing products. |
sellers | integer | optional | Number of sellers. |
avgPrice | number | optional | Average price. |
itemsViews | number | optional | Product visibility. |
viewSharing | number | optional | Browse concentration, percentage. |
conversionSharing | number | optional | Conversion concentration, percentage. |
marketSpace | number | optional | market space. |
returnCancellationRate | number | optional | Return cancellation rate, percentage. |
uniqQueriesWCa | integer | optional | Number of additional purchases. |
ca | number | optional | Add-to-purchase conversion rate, percentage. |
relevancy | number | optional | Relevance to seed words. |
titleDensity | number | optional | Title Density. |
wordCount | integer | optional | word count. |
categories | array | optional | Array of category IDs. |
categoryInfos | array | optional | Category information; actually measured in `data[*]`, it is usually not returned. The structure is shown in the table below. |
products | array | optional | Top product data, element fields are shown in the table below. |
id | string | optional | Record ID. |
ozonId | integer | optional | Ozon product ID. |
sku | integer | optional | SKU ID。 |
title | string | optional | Product title, Russian. |
imageUrl | string | optional | Main image URL. |
advert | integer | optional | Advertising logo: `0` / `1`. |
titleCn | string | optional | Category Chinese name. |
titleEn | string | optional | Category English name. |
titleRu | string | optional | Category Russian name. |
cnTitlePath | string | optional | Chinese category path. |
enTitlePath | string | optional | English category path. |
titlePath | string | optional | Russian category path. |
id | string | optional | Category ID. |
crossBorderSellable | boolean | optional | Whether it can be sold across borders. |
Responses
| Code | Description |
|---|---|
| 200 | Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result. |
| 429 | Execution admission rate limit; honor Retry-After when present. |
| 503 | Execution admission is temporarily unavailable; honor Retry-After when present. |
| Opt-in | X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses. |
Data source, freshness, and limitations
Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.