AMALYZE Falcon API

research.product.keywords.frequencies (POST)

Endpoint

Endpoint research.product.keywords.frequencies returns for a specific ASIN the most relevant one-, two-, three-, four- and five-word keyword combinations and weights them

Method

POST research.product.keywords.frequencies

Example call

curl https://falcon.amalyze.com/<VERSION>/research.products.search \
-X POST \
-H "X-Falcon-Token: <YOUR-TOKEN-HERE>" \
-d '
{
	"filters":{
		"marketplace":"A1PA6795UKMFR9",
		"asin":"B07378Y15Q",
		"wordCount": 3
	},
	"sorting":[
		{
			"direction":"desc",
			"column":"frequency"
		}
	],
	"pagination": {
		"page": 1,
		"size": 100
	}
}
'

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

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

-X POST \

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

-d '

{

"filters":{

"marketplace":"A1PA6795UKMFR9",

"asin":"B07378Y15Q",

"wordCount": 3

},

"sorting":[

{

"direction":"desc",

"column":"frequency"

}

],

"pagination": {

"page": 1,

"size": 100

}

'

JSON Payload

{
	"filters":{
		"marketplace":"A1PA6795UKMFR9",
		"asin":"B07378Y15Q",
		"wordCount": 3
	},
	"sorting":[
		{
			"direction":"desc",
			"column":"frequency"
		}
	],
	"pagination": {
		"page": 1,
		"size": 100
	}
}

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

{

"filters":{

"marketplace":"A1PA6795UKMFR9",

"asin":"B07378Y15Q",

"wordCount": 3

},

"sorting":[

{

"direction":"desc",

"column":"frequency"

}

],

"pagination": {

"page": 1,

"size": 100

}

Property	Type	Description	Further information	Version
`pagination`	object	Object containing the pagination information	pagination object definition	0.1.16
`filters`	object	Object containing the filter information		0.1.16
`filters.marketplace`	string	String containing the marketplace ID	required. valid marketplaces ids	0.1.16
`filters.asin`	string	String containing the ASIN to received competitors fors	required	0.1.16
`filters.wordCount`	integer	Integer containing the required number of word.	required `1`: single keywords `2`: two-word combinations `3`: 3-words combination `4`: four-word combination `5`: five-word combination	0.1.16
`sorting`	array	Array containing the sorting information		0.1.16
`sorting.column`	string	The column to sort	`frequency`: sort by frequency `term`: sort by term	0.1.16
`sorting.direction`	string	The direction to sort	valid direction values	0.1.16

JSON Response

{
    "items": [
        {
            "term": "premium protection pants",
            "frequency": 1
        }
    ],
    "request": {
        "id": "b2381374-1749-48fb-ab70-a270e907cd15",
        "took": 0.087,
        "costs": 1,
        "remaining": 99999,
        "method": "research.product.keywords.frequencies",
        "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": [

{

"term": "premium protection pants",

"frequency": 1

}

],

"request": {

"id": "b2381374-1749-48fb-ab70-a270e907cd15",

"took": 0.087,

"costs": 1,

"remaining": 99999,

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

"success": true,

"error": {

"code": null,

"message": null,

"hint": null

}

Property	Type	Description
`items`	array	Array containing the terms and frequencies
`items.term`	string	String containing the term
`items.frequency`	float	Float containing the weighted frequency for the term (0 - 1)
`pagination`	object	The pagination object (see Pagination for more information)
`request`	object	The request inforamtion object (see Request information for more information)