AMALYZE Falcon API

notifications.products (SUM)

Endpoint

Endpoint notifications.products returns the summary for individual user notifications for product changes

Endpoint

SUM notifications.products

Example call

curl https://falcon.amalyze.com/<VERSION>/notifications.products\
-H "X-Falcon-Token: <YOUR-TOKEN-HERE>" \
-X SUM \
-d '
{
	"filters": {
		"marketplaces": [
			"A1RKKUPIHCS9HS",
			"A1PA6795UKMFR9"
		],
		"asin": "B123456789",
		"parent": "B112233445",
		"change": [
			"down",
			"up"
		],
		"types": [
			"content.title"
		],
		"read": [
			false,
			true
		],
		"brand": "Sample brand",
		"start": "2019-01-01",
		"end": "2019-02-28"
	}
}'

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

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

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

-X SUM \

-d '

{

"filters": {

"marketplaces": [

"A1RKKUPIHCS9HS",

"A1PA6795UKMFR9"

],

"asin": "B123456789",

"parent": "B112233445",

"change": [

"down",

"up"

],

"types": [

"content.title"

],

"read": [

false,

true

],

"brand": "Sample brand",

"start": "2019-01-01",

"end": "2019-02-28"

}

}'

JSON Payload

{
	"filters": {
		"marketplaces": [
			"A1RKKUPIHCS9HS",
			"A1PA6795UKMFR9"
		],
		"asin": "B123456789",
		"parent": "B112233445",
		"change": [
			"down",
			"up"
		],
		"types": [
			"content.title"
		],
		"read": [
			false,
			true
		],
		"brand": "Sample brand",
		"start": "2019-01-01",
		"end": "2019-02-28"
	}
}

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

{

"filters": {

"marketplaces": [

"A1RKKUPIHCS9HS",

"A1PA6795UKMFR9"

],

"asin": "B123456789",

"parent": "B112233445",

"change": [

"down",

"up"

],

"types": [

"content.title"

],

"read": [

false,

true

],

"brand": "Sample brand",

"start": "2019-01-01",

"end": "2019-02-28"

}

Property	Type	Description	Further information
`filters`	object	Object containing the filter information
`filters.start`	date	String containing the start date	YYYY-MM-DD
`filters.end`	date	String containing the end date	YYYY-MM-DD
`filters.marketplaces`	array	Array containing the marketplace ids	valid marketplaces ids
`filters.asin`	string	String containing the ASINs	optional
`filters.parent`	string	String containing the parent’s ASIN	optional
`filters.change`	array	Array containing the direction of change	optional `up`: increased value `down`: decreased value `content`: length did not change, but content
`filters.type`	array	Array containing the type of change	optional `content.category` `content.title` `content.bulletpoints` `content.parent` `buybox.merchant` `buybox.price` `buybox.unitPrice` `reviews.reviews` `reviews.rating`
`filters.brand`	string	String containing the brand to search for	optional

JSON Response

{
    "items": [
        {
            "type": "content.category",
            "change": null,
            "total": {
                "notifications": 0,
                "asins": 0
            },
            "unread": {
                "notifications": 0,
                "asins": 0
            }
        },
        {
            "type": "content.title",
            "change": "up",
            "total": {
                "notifications": 0,
                "asins": 0
            },
            "unread": {
                "notifications": 0,
                "asins": 0
            }
        },
        {...},
        {...},
        {
            "type": "badge.bestseller",
            "change": "down",
            "total": {
                "notifications": 0,
                "asins": 0
            },
            "unread": {
                "notifications": 0,
                "asins": 0
            }
        }
    ],
    "request": {
        "id": "9db38236-8749-4a44-87a7-4218534d5d73",
        "took": 0.1882,
        "costs": 0,
        "remaining": 100000,
        "method": "notifications.products",
        "success": true,
        "error": {
            "code": null,
            "message": null,
            "hint": null
        },
        "cache": {
            "cached": false,
            "id": 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

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

{

"items": [

{

"type": "content.category",

"change": null,

"total": {

"notifications": 0,

"asins": 0

},

"unread": {

"notifications": 0,

"asins": 0

}

},

{

"type": "content.title",

"change": "up",

"total": {

"notifications": 0,

"asins": 0

},

"unread": {

"notifications": 0,

"asins": 0

}

},

{...},

{

"type": "badge.bestseller",

"change": "down",

"total": {

"notifications": 0,

"asins": 0

},

"unread": {

"notifications": 0,

"asins": 0

}

],

"request": {

"id": "9db38236-8749-4a44-87a7-4218534d5d73",

"took": 0.1882,

"costs": 0,

"remaining": 100000,

"method": "notifications.products",

"success": true,

"error": {

"code": null,

"message": null,

"hint": null

},

"cache": {

"cached": false,

"id": null

}

Property	Type	Description
`items`	array	Array containing the summary items
`items.type`	string	String indicating the notification type. Valid items are: `content.category` `content.title` `content.image` `content.bulletpoints` `buybox.merchant` `buybox.price` `reviews.reviews` `reviews.rating` `badge.bestseller`
`items.change`	string	String indication, if prices went up or down, titles or bulletpoints have been shrinked or enlarged, number of reviews went up or down, ratings went up or down. Valid values: `null` `down` `up`
`items.total`	object	Object containing the total number for all notifications
`items.total.notifications`	integer	Integer containing the total number of notifications
`items.total.asins`	integer	Integer containing the total number of affected asins
`items.unread`	object	Object containing the total number for all unread notifications
`items.unread.notifications`	integer	Integer containing the total number of unread notifications
`items.unread.asins`	integer	Integer containing the total (unread) number of affected asins
`request`	object	The request information object (see request information object definition for more information)