AMALYZE Falcon API

research.products.keywords (POST)

Endpoint

Endpoint research.products.keywords returns the organic keywords for multiple ASINs.

Method

POST research.products.keywords

Example call

curl https://falcon.amalyze.com/<VERSION>/research.products.keywords \
-X POST \
-H "X-Falcon-Token: <YOUR-TOKEN-HERE>" \
-d '
{
	"filters":{
		"marketplace":"A1PA6795UKMFR9",
		"asins":[
			"B07BBSZW9R",
			"B01CJ5MHRW"
		],
		"keywordPhrase": "opc"
	},
	"pagination":{
		"page":1,
		"size":10
	},
	"sorting":[
		{
			"direction":"desc",
			"column":"stats.count"
		}
	]
}
'

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

curl https://falcon.amalyze.com/<VERSION>/research.products.keywords \

-X POST \

-H "X-Falcon-Token: <YOUR-TOKEN-HERE>" \

-d '

{

"filters":{

"marketplace":"A1PA6795UKMFR9",

"asins":[

"B07BBSZW9R",

"B01CJ5MHRW"

],

"keywordPhrase": "opc"

},

"pagination":{

"page":1,

"size":10

},

"sorting":[

{

"direction":"desc",

"column":"stats.count"

}

]

}

'

JSON Payload

{
	"filters":{
		"marketplace":"A1PA6795UKMFR9",
		"asins":[
			"B07BBSZW9R",
			"B01CJ5MHRW"
		],
		"keywordPhrase": "opc"
	},
	"pagination":{
		"page":1,
		"size":10
	},
	"sorting":[
		{
			"direction":"desc",
			"column":"stats.count"
		}
	]
}

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

{

"filters":{

"marketplace":"A1PA6795UKMFR9",

"asins":[

"B07BBSZW9R",

"B01CJ5MHRW"

],

"keywordPhrase": "opc"

},

"pagination":{

"page":1,

"size":10

},

"sorting":[

{

"direction":"desc",

"column":"stats.count"

}

]

}

Property	Type	Description	Further information	Version
`pagination`	object	Object containing the pagination information	pagination object definition	0.3.0
`filters`	object	Object containing the filter information		0.3.0
`filters.asins`	array	Array containing the ASINs to fetch keywords for		0.3.0
`filters.marketplace`	date	The marketplace-ID, for which ranking data is requested for.	valid marketplace-IDs	0.3.0
`filters.keywordExact`	string	Only return items, matching (exact) the required keyword	optional	0.3.0
`filters.keywordPhrase`	string	Only return items, matching (phrase) the required keyword	optional	0.3.0
`sorting`	array	Array containing the sorting information		0.3.0
`sorting.column`	string	The column to sort	`keyword`: sort by the keyword alphabetically `change`: sort by the type of change `stats.salesRate`:: sort by salesRate `stats.impressions`: sort by impressions `stats.count`: sort by occurence	0.3.0
`sorting.direction`	string	The direction to sort	valid direction values	0.3.0

JSON Response

{
	"items": [
		{<keywordranking>}
	],
	"pagination": {
		"filtered": 245
	},
	"request": {
		"id": "ec0c1c94-d355-413f-813d-74827489c797",
		"took": 0.4768,
		"costs": 1,
		"remaining": 99999,
		"method": "research.product.keywords.get",
		"success": true,
		"error": {
			"code": null,
			"message": null,
			"hint": null
		}
	}
}

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

{

"items": [

{<keywordranking>}

],

"pagination": {

"filtered": 245

},

"request": {

"id": "ec0c1c94-d355-413f-813d-74827489c797",

"took": 0.4768,

"costs": 1,

"remaining": 99999,

"method": "research.product.keywords.get",

"success": true,

"error": {

"code": null,

"message": null,

"hint": null

}

Property	Type	Description
`items`	array	The keywords for the requested ASIN (see products keyword object definition for more information)
`pagination`	object	The pagination object (see request information object definition for more information
`request`	object	The request information object (see request information object definition for more information