AMALYZE Falcon API

research.product.keywords.distribution (POST)

Endpoint

Endpoint research.product.keywords.distribution returns the keyword distribution for an ASIN / marketplace combination

Method

POST research.product.keywords.distribution

Example call

curl https://falcon.amalyze.com/<VERSION>/research.product.keywords.distribution \
-X POST \
-H "X-Falcon-Token: <YOUR-TOKEN-HERE>" \
-d '
{
	"filters": {
		"marketplace": "A1PA6795UKMFR9",
		"asin": "B0014TE6FG"
	},
	"aggregation": "position"
}
'

1

2

3

4

5

6

7

8

9

10

11

12

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

-X POST \

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

-d '

{

"filters": {

"marketplace": "A1PA6795UKMFR9",

"asin": "B0014TE6FG"

},

"aggregation": "position"

}

'

JSON Payload

Property	Type	Description	Further information
`filters`	object	Object containing the filter information
`filters.asin`	string	The ASIN, for which ranking data is requested for
`filters.marketplace`	string	The marketplace-ID, for which ranking data is requested for.	valid marketplace-IDs
`aggregation`	string	How distribution shall be aggregated	`position`: aggregates the rankings by position `page`: aggregates the rankings by page (16 results per page)

JSON Response

{
	"items": [
		{
			"position": 1,
			"count": 47,
			"aggregation": "position"
		},
		{
			"position": 2,
			"count": 42,
			"aggregation": "position"
		},
		{
			"position": 3,
			"count": 30,
			"aggregation": "position"
		}
    ],
	"request": {
		"id": "57c52e17-7489-4cf6-ae8d-afad4220aa01",
		"took": 0.9631,
		"costs": 91,
		"remaining": 99909,
		"method": "research.product.keywords.distribution",
		"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

22

23

24

25

26

27

28

29

30

31

32

{

"items": [

{

"position": 1,

"count": 47,

"aggregation": "position"

},

{

"position": 2,

"count": 42,

"aggregation": "position"

},

{

"position": 3,

"count": 30,

"aggregation": "position"

}

],

"request": {

"id": "57c52e17-7489-4cf6-ae8d-afad4220aa01",

"took": 0.9631,

"costs": 91,

"remaining": 99909,

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

"success": true,

"error": {

"code": null,

"message": null,

"hint": null

}

Property	Type	Description
`items`	array	Array containing the aggregated keyword distribution
`items.position`	integer	The current position according the the requested aggregation
`items.count`	integer	The number of keywords, the product ranks for the specific position
`items.aggregation`	string	The type of aggregation position: aggregates the rankings by position page: aggregates the rankings by page (16 results per page)
`request`	object	The request information object (see request information object definition for more information)