https://api.nexscope.ai/ss/market/statisticsRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/ss/market/statistics |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
marketplace | string | required | Site encoding Example: US |
nodeIdPath | string | required | Node ID path string, for example `1064954:1069242:1069784:1069820:1069838:1069828` |
month | string | optional | `nearly` or `yyyyMM` |
topN | integer | optional | Number of head Listings, used for head-related indicator caliber Example: 10 |
newProduct | integer | optional | New product definition (month) Example: 6 |
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 (49 fields)
| Name | Type | Required | Description |
|---|---|---|---|
total | integer | optional | Total number of items |
marketplace | string | optional | Site encoding |
data | array | optional | List of statistical results (corresponding to third-party `data`) |
columns | array | optional | Rendered columns |
costToken | integer | optional | Consume token |
type | string | optional | rendering style |
nodeIdPath | string | optional | Node ID path |
nodeLabelPath | string | optional | Node name path |
nodeLabelLocale | string | optional | Node name translation |
nodeLabelPathLocale | string | optional | Node name path translation |
marketplace | string | optional | market sign |
countryCode | string | optional | Country 2 short code |
currency | string | optional | The currency type of this market |
totalProducts | integer | optional | Total number of items |
products | integer | optional | Number of sample items |
sellers | integer | optional | Number of sellers |
brands | integer | optional | Number of brands |
avgSellers | number | optional | Average number of sellers |
hlProducts | integer | optional | Number of samples of the top N products in the header Listing |
avgUnits | integer | optional | average monthly sales |
avgRevenue | number | optional | average monthly sales |
avgPrice | number | optional | average price |
avgRating | number | optional | average star rating |
avgRatings | integer | optional | average rating |
avgRatingsCv | integer | optional | Average number of comments per month |
avgBsr | integer | optional | Average BSR |
avgProfit | number | optional | average profit margin |
avgWeight | number | optional | Average weight (pound) |
baseAvgWeight | number | optional | Average weight (g) |
avgVolume | number | optional | Average volume (in³) |
baseAvgVolume | number | optional | Average volume (cm³) |
hlAvgUnits | integer | optional | The average monthly sales volume of the top N products in the header Listing |
hlAvgRevenue | number | optional | Average monthly sales of the top N products in the header Listing |
hlAvgPrice | number | optional | The average price of the top N items in the header Listing |
hlAvgRating | number | optional | Head Listing Average star rating of the top N products |
hlAvgRatings | integer | optional | Average number of reviews for the top N products in the head Listing |
hlAvgRatingsCv | integer | optional | The average number of monthly reviews of the top N products in the head Listing |
hlAvgBsr | integer | optional | Average BSR of the top N products in the head Listing |
newProducts | integer | optional | New product quantity |
newProductProportion | number | optional | New product quantity proportion |
newAvgUnits | integer | optional | Average monthly sales of new products |
newAvgRevenue | number | optional | Average monthly sales of new products |
newAvgPrice | number | optional | Average new product price |
newAvgRating | number | optional | Average star rating of new products |
newAvgRatings | integer | optional | Average rating of new products |
minNewRatings | integer | optional | Lowest new product rating |
maxNewRatings | integer | optional | Highest new product rating |
firstShelfDate | string | optional | Product first put on shelves date |
lastShelfDate | string | optional | Product latest shelf date |
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.