AMALYZE Falcon API

research.keywords (POST)

Endpoint

Endpoint research.keywords returns keywords (and their general information) based on the filters

Method

POST research.keywords

Example call

curl https://falcon.amalyze.com/<VERSION>/research.keywords.search \
-X POST \
-H "X-Falcon-Token: <YOUR-TOKEN-HERE>" \
-d '
{
	"pagination": {
		"size": 1, 
		"page": 1
	}, 
	"filters": {
		"marketplaces": [
			"A1PA6795UKMFR9"
		], 
		"keywordPhrase": "abc"
	}, 
	"sorting": [
		{
			"column": "score", 
			"direction": "asc"
		}
	]
}'

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

-X POST \

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

-d '

{

"pagination": {

"size": 1,

"page": 1

"filters": {

"marketplaces": [

"A1PA6795UKMFR9"

"keywordPhrase": "abc"

"sorting": [

{

"column": "score",

"direction": "asc"

}

]

JSON Payload

{
	"pagination": {
		"size": 1, 
		"page": 1
	}, 
	"filters": {
		"marketplaces": [
			"A1PA6795UKMFR9"
		], 
		"keywordPhrase": "abc"
	}, 
	"sorting": [
		{
			"column": "score", 
			"direction": "asc"
		}
	]
}

{

"pagination": {

"size": 1,

"page": 1

"filters": {

"marketplaces": [

"A1PA6795UKMFR9"

"keywordPhrase": "abc"

"sorting": [

{

"column": "score",

"direction": "asc"

}

]

}

Property	Type	Description	Further information
`pagination`	object	The object containing the pagination information	pagination object definition
`filters`	object	The object containing the filter information
`filters.marketplaces`	array	Array containing the marketplaces	valid marketplaces ids
`filters.keywordPhrase`	string	Search (phrase) within keywords	optional
`filters.keywordExact`	string	Search (exact) within keywords	optional
`filters.query`	string	Fulltext search over all available fields	optional
`filters.statsSales`	object	Object containing the filter information to filter for the monthly sales	optional
`filters.statsSales.min`	float	The minimum monthly sales	optional
`filters.statsSales.max`	float	The maximum monthly sales	optional
`filters.statsImpressions`	object	Object containing the filter information to filter for the monthly searchVolume	optional
`filters.statsImpressions.min`	float	The minimum monthly searchVolume	optional
`filters.statsImpressions.max`	float	The minimum monthly searchVolume	optional
`sorting`	array	Array containing the sorting information
`sorting.column`	string	The column to sort	`keyword.keyword`: sort by keyword `score`: sort by internal matching score `brand`: sort by number of brand `buybox.merchants`: sort by number of merchants `buybox.rate`: sort by rate of buybox `buybox.stroke.rate`: sort by rate of stroke-prices `buybox.offer.amount`: sort by (buybox) amount `results.advertising.spa.count`: sort by number of products, advertising as sponsored product ads `result.organic.count`: sort by number of organic results `categories.count`: sort by number of different categories `categories.main.name`: sort by main category name `filters.prime.rate`: sort be rate of prime-offered products `filters.subscription.rate`: sort by rate of products, offered as subscription `filters.plus.rate`: sort by rate of products, offered as plus product `reviews.total`: sort by number of review `rating.score`: sort by rating (stars) `update.last`: sort by last update timestamp `stats.impressions`sort by searchVolumne `stats.sales`sort by sales
`sorting.direction`	string	The direction to sort	valid direction values

JSON Response

{
	"items": [
		{<keyword>}
	],
	"pagination": {
		"filtered": 5923
	},
	"request": {
		"id": "b92fc9dc-56f8-4858-8c76-71c97a45f27e",
		"took": 0.0698,
		"costs": 1,
		"remaining": 99999,
		"method": "research.keywords.search",
		"success": true,
		"error": {
			"code": null,
			"message": null,
			"hint": null
		}
	}
}

{

"items": [

{<keyword>}

"pagination": {

"filtered": 5923

"request": {

"id": "b92fc9dc-56f8-4858-8c76-71c97a45f27e",

"took": 0.0698,

"costs": 1,

"remaining": 99999,

"method": "research.keywords.search",

"success": true,

"error": {

"code": null,

"message": null,

"hint": null

}

Property	Type	Description
`items`	array	Array containing the product items (for more information see keyword object definition
`pagination`	object	Object containing the pagination information (for more information see pagination object definition)
`request`	object	The request information object (see request information object definition for more information)

Updates / Changes

Version	Description
0.1.15	renamed endpoint to `research.keywords`
	added response property `stats.impressions`
	added response property `stats.sales`
	added filter property `statsSales`
	added filter property `statsImpressions`
0.1.12	renamed property `filters.amalyze.generic` to `filters.query`
	added filter property `filters.keywordExact`
	added filter property `filters.keywordPhrase`