POSThttps://api.nexscope.ai/api/skill-api/v1/skills/amazon-keyword-intelligence/run

Run this API

Send a JSON request to execute this API and receive the documented response payload.

Endpoint

Method	`POST`
Path	`https://api.nexscope.ai/api/skill-api/v1/skills/amazon-keyword-intelligence/run`
Auth	`Bearer API key`
Content-Type	`application/json`

Request parameters

Name	Type	Required	Description
`analysisDescription`	`string`	required	Natural language description that precisely expresses the query intent Example: Analyze Amazon Brand Analytics search demand for phone case in the US marketplace
`region`	`string`	optional	Site code, default US. Options: US, DE, BR, CA, AU, JP, AE, ES, FR, IT, SA, TR, MX, SE, NL Example: US
`createDownloadUrl`	`boolean`	optional	Whether to generate a CSV download link, default false Example: false

Code example

{
  "analysisDescription": "Find Amazon Brand Analytics search demand for phone case in the US marketplace",
  "region": "US",
  "createDownloadUrl": false
}

Response example

Platform response envelope. code 0 indicates success or acceptance; data contains the business result.

{
  "data": {
    "success": false,
    "tables": [
      {
        "data": [],
        "columns": []
      }
    ],
    "total": 1,
    "downloadUrl": "https://example.com/image.jpg",
    "costTime": 1,
    "costToken": 1
  },
  "code": 0,
  "msg": null,
  "ts": "0",
  "time": "2026-01-01 00:00:00",
  "cost": "-1",
  "traceId": null
}

Response fields

Name	Type	Required	Description
`data`	`any`	required	Data value used by this API operation.
`code`	`integer`	required	0 means accepted or successful; nonzero is a platform error.
`msg`	`string \| null`	required	Msg value used by this API operation.
`ts`	`string`	required	Epoch milliseconds.
`time`	`string`	required	Server local time: yyyy-MM-dd HH:mm:ss.
`cost`

Responses

Code	Description
200	HTTP request completed. Check JSON code; only 0 indicates business success or acceptance.
400	Request JSON or required API parameters are invalid.
401	API key is missing, invalid, or cannot be matched to a user.
5xx	API execution or upstream service failed.

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.

Name

Type

Required

Description

data

object

required

Data value used by this API operation.

data.success

boolean

optional

Whether the query succeeded

Example: false

data.tables

array

optional

Result data array, each element containing data (data rows), columns (column definitions), name (Sheet name)

Example: []

data.tables[]

object

required

Item in data tables.

data.tables[].data

array

optional

Query result rows; actual columns vary with the query

Example: []

data.tables[].data[]

object

required

Item in data tables[] data.

data.tables[].data[].searchTerm

string

optional

Consumer search term

Example: null

data.tables[].data[].reportStartDate

string

optional

Start date of the reporting week

Example: null

data.tables[].data[].region

string

optional

Amazon marketplace code

Example: null

data.tables[].data[].searchFrequencyRank

integer

optional

Search frequency rank; lower values indicate higher popularity

Example: null

data.tables[].data[].clickedAsin

string

optional

ASIN of the clicked product

Example: null

data.tables[].data[].clickedItemName

string

optional

Name of the clicked product

Example: null

data.tables[].data[].clickShareRank

integer

optional

Click share rank of this ASIN for the search term

Example: null

data.tables[].data[].clickShare

number

optional

Click share for this ASIN, from 0 to 1

Example: null

data.tables[].data[].conversionShare

number

optional

Conversion share for this ASIN, from 0 to 1

Example: null

data.tables[].columns

array

optional

Result column definitions

Example: []

data.tables[].name

string

optional

Sheet name

Example: null

data.total

integer

optional

Total result count

Example: 1

data.downloadUrl

string

optional

When createDownloadUrl is true, returns the CSV file URL

Example: https://example.com/image.jpg

data.downloadNote

string

optional

Download-related note

Example: null

data.costTime

integer

optional

Latency (ms)

Example: 1

data.costToken

integer

optional

Tokens consumed

Example: 1

data.type

string

optional

Provider-specific render or payload type.

Example: null

data.title

string

optional

Provider-specific response title.

Example: null

data.sourceType

string

optional

Provider-specific source platform type.

Example: null

data.sourceTool

string

optional

Provider-specific source tool name.

Example: null

data.page

integer

optional

Current page returned by the upstream provider.

Example: null

data.pageSize

integer

optional

Page size returned by the upstream provider.

Example: null

data.pageItemCount

integer

optional

Item count on the current page returned by the upstream provider.

Example: null

data.totalPage

integer

optional

Total page count returned by the upstream provider.

Example: null

data.dataSnapshotMonth

string

optional

Data snapshot month returned by the upstream provider.

Example: null

Name

Type

Required

Description

data

null

required

Data value used by this API operation.

Amazon Keyword Intelligence

What this API does

Amazon Keyword Intelligence

What this API does

Authentication

Run an API

Example request

Check the response

HTTP status codes

Run this API

Endpoint

Request parameters

Code example

Response example

Response fields

Responses

Data source, freshness, and limitations

MCP

Call a tool

Legacy MCP v1

Online test

Try it

Related APIs

Any of option 1

Any of option 2