Keyword & Search Demand

Amazon Keyword Summary

Break down all competitor ASIN traffic sources under a given keyword -- organic search, SP ads, SB brand ads, SBV video ads, SP recommendations, AC/ER/TR recommendation slots, with support for ASIN filtering, custom date ranges, and new traffic keyword filters. Trigger when the user mentions keyword traffic sources, which competitors are grabbing traffic under this keyword, organic traffic vs paid traffic share, SP ad exposure, brand ad share, SP recommendation slots, recommendation ad/non-ad split, search display analysis, Amazon's Choice or editorial recommendation exposure, keyword competitive landscape, ASIN traffic composition, keyword traffic, traffic structure analysis, search share, ad share, traffic source distribution, Nexscope, traffic analysis, SP recommendation, recommend position breakdown. Even if the user does not explicitly mention "Nexscope", if their need involves analyzing competitor ASIN traffic source distribution under a keyword, this skill should also be triggered.

post/api/skill-api/v1/skills/amazon-keyword-summary/run

Request

  • Base URL: https://api.nexscope.ai
  • URL: https://api.nexscope.ai/api/skill-api/v1/skills/amazon-keyword-summary/run
  • Auth: HTTP bearer

Headers

X-Nexscope-Http-Status'legacy' | 'semantic'

Use semantic for HTTP error statuses on run and task-result requests. Without this header v1 retains legacy status behavior. The JSON envelope is unchanged; code 0 means success or acceptance, not asynchronous completion.

Request body

searchKeywordstring required

Search keyword, translate to the corresponding country's language whenever possible. Max length 1000 characters

countrystring

Country site, default US. Options (13 total): US, UK, DE, CA, JP, FR, ES, IT, MX, AU, AE, BR, SA

asinsstring

ASIN filter list, comma-separated; if not provided, returns all ASINs for this keyword. Max length 1000 characters

conditionstring

Condition filter, only one at a time.<br>Flag type: nfPosition (natural traffic keyword), isSpAd (SP ad keyword), isVedioAd (video ad keyword), isBrandAd (brand ad keyword), isPPCAd (PPC ad keyword), isSearchRecommend (search recommendation keyword), acAd (SP recommendation)<br>Period count type: totalPeriod.in (new incoming traffic keywords), nfKeywordCnt.total / .in, adKeywordCnt.total / .in, allSpKeywordCnt.total / .in, spKeywordCnt.total / .in, recSpKeywordCnt.total / .in, allSbKeywordCnt.total / .in, sbKeywordCnt.total / .in, sbvKeywordCnt.total / .in

last7dboolean

Whether to get last 7 days data, default true. When false, use startDate/endDate range

startDatestring

Start date yyyy-MM-dd (effective when last7d=false; if omitted, the latest system full week is used)

endDatestring

End date yyyy-MM-dd (paired with startDate)

sortBystring

Sort field. Options: totalKeywordNum (all traffic keywords), naturalKeywordNum (natural traffic keywords), brandKeywordNum (brand ad keywords), vedioKeywordNum (video ad keywords), acKeywordNum (AC recommended keywords), erKeywordNum (ER recommended keywords), trKeywordNum (TR recommended keywords), sumScore (total keyword exposure score), totalNfScore, totalSpSocre (note spelling), totalBrandScore, totalVedioScore, totalAcScore, totalTrScore, totalErScore

pageNuminteger

Page number, default 1

pageSizeinteger

Results per page, min 10, max 100, default 100

descboolean

Whether to sort descending, default true

Example request

{
  "searchKeyword": "phone case",
  "pageSize": 10,
  "last7d": true,
  "pageNum": 1,
  "country": "US"
}

Response

Successful response.

codeinteger required

0 means accepted or successful; nonzero is a platform error.

msgstring nullable required
tsstring required

Epoch milliseconds.

timestring required

Server local time: yyyy-MM-dd HH:mm:ss.

coststring required

Elapsed milliseconds, never credits; -1 outside web requests.

traceIdstring nullable required

Example response

{
  "data": {
    "total": 1,
    "data": [],
    "costTime": 1,
    "costToken": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.