AMALYZE Falcon API

research.keyword.rankings (POST)

Endpoint

Endpoint research.keyword.rankings returns ranking products for a specific keyword

Method

POST research.keyword.rankings

Example call

curl https://falcon.amalyze.com/<VERSION>/research.keyword.rankings \
-X POST \
-H "X-Falcon-Token: <YOUR-TOKEN-HERE>" \
-d '
{
	"pagination": {
		"page": 1, 
		"size": 10
	}, 
	"keyword": "fatburner", 
	"marketplace": "A1PA6795UKMFR9"
}'

1

2

3

4

5

6

7

8

9

10

11

12

curl https://falcon.amalyze.com/<VERSION>/research.keyword.rankings \

-X POST \

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

-d '

{

"pagination": {

"page": 1,

"size": 10

},

"keyword": "fatburner",

"marketplace": "A1PA6795UKMFR9"

}'

JSON Payload

Property	Type	Description	Further information
`pagination`	object	The object containing the pagination information	pagination object definition
`keyword`	string	The keyword, which rankings shall be returned for
`marketplace`	string	The marketplace-ID, for which ranking data is requested for.	valid marketplace-IDs

JSON Response

{
    "items": [
        {<product>}
    ],
    "request": {
        "id": "708f6b29-0c41-4cd1-ba9a-4346a66fedf9",
        "took": 0.0571,
        "costs": 1,
        "remaining": 99999,
        "method": "research.product.general.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

{

"items": [

{<product>}

],

"request": {

"id": "708f6b29-0c41-4cd1-ba9a-4346a66fedf9",

"took": 0.0571,

"costs": 1,

"remaining": 99999,

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

"success": true,

"error": {

"code": null,

"message": null,

"hint": null

}

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