AMALYZE Falcon API

pulse.serps.categories.histogram (POST)

Endpoint

Endpoint pulse.serps.categories.histogram returns the volatility information for main categories of a certain marketplace.

Method

POST pulse.serps.categories.histogram

Example call

curl https://falcon.amalyze.com/<VERSION>/pulse.serps.categories.histogram \
-X POST \
-H "X-Falcon-Token: <YOUR-TOKEN-HERE>" \
-d '
{
	"marketplace": "A1PA6795UKMFR9"
}
'

1

2

3

4

5

6

7

8

curl https://falcon.amalyze.com/<VERSION>/pulse.serps.categories.histogram \

-X POST \

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

-d '

{

"marketplace": "A1PA6795UKMFR9"

}

'

JSON Payload

Property	Type	Description	Further information	Version
`filters.marketplace`	string	String containing the marketplace id	valid marketplaces ids	0.3.0

JSON Response

{
    "items": [
        {
            "dimensions": {
                "date": "2019-03-20"
            },
            "series": [
                {
                    "dimension": {
                        "category": {
                            "id": "2454118031",
                            "name": "Koffer"
                        },
                        "marketplace": "A1PA6795UKMFR9"
                    },
                    "metrics": {
                        "volatility": 19.946646200228
                    }
                },
                {
                    "dimension": {
                        "category": {
                            "id": "80084031",
                            "name": "Baumarkt"
                        },
                        "marketplace": "A1PA6795UKMFR9"
                    },
                    "metrics": {
                        "volatility": 38.571693995652
                    }
                },
                { ... },
                { ... },
                { ... }
            ]
        },
        {
            "dimensions": {
                "date": "2019-03-20"
            },
            "series": [
                {
                    "dimension": {
                        "category": {
                            "id": "2454118031",
                            "name": "Koffer"
                        },
                        "marketplace": "A1PA6795UKMFR9"
                    },
                    "metrics": {
                        "volatility": 19.946646200228
                    }
                },
                {
                    "dimension": {
                        "category": {
                            "id": "80084031",
                            "name": "Baumarkt"
                        },
                        "marketplace": "A1PA6795UKMFR9"
                    },
                    "metrics": {
                        "volatility": 38.571693995652
                    }
                },
                { ... },
                { ... },
                { ... }
            ]
        }		
    ],
    "request": {
        "id": "572414a9-dfb7-405e-99f2-1ffacc0110ef",
        "took": 0.2737,
        "costs": 0,
        "remaining": 100000,
        "method": "pulse.serps.categories.histogram",
        "success": true,
        "error": {
            "code": null,
            "message": null,
            "hint": null
        },
        "cache": {
            "ttl": 23416,
            "cached": true,
            "id": "40367f8ad2b415c05faaabddfef1367b"
        }
    }
}

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

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

{

"items": [

{

"dimensions": {

"date": "2019-03-20"

},

"series": [

{

"dimension": {

"category": {

"id": "2454118031",

"name": "Koffer"

},

"marketplace": "A1PA6795UKMFR9"

},

"metrics": {

"volatility": 19.946646200228

}

},

{

"dimension": {

"category": {

"id": "80084031",

"name": "Baumarkt"

},

"marketplace": "A1PA6795UKMFR9"

},

"metrics": {

"volatility": 38.571693995652

}

},

{ ... },

{ ... }

]

},

{

"dimensions": {

"date": "2019-03-20"

},

"series": [

{

"dimension": {

"category": {

"id": "2454118031",

"name": "Koffer"

},

"marketplace": "A1PA6795UKMFR9"

},

"metrics": {

"volatility": 19.946646200228

}

},

{

"dimension": {

"category": {

"id": "80084031",

"name": "Baumarkt"

},

"marketplace": "A1PA6795UKMFR9"

},

"metrics": {

"volatility": 38.571693995652

}

},

{ ... },

{ ... }

]

}

],

"request": {

"id": "572414a9-dfb7-405e-99f2-1ffacc0110ef",

"took": 0.2737,

"costs": 0,

"remaining": 100000,

"method": "pulse.serps.categories.histogram",

"success": true,

"error": {

"code": null,

"message": null,

"hint": null

},

"cache": {

"ttl": 23416,

"cached": true,

"id": "40367f8ad2b415c05faaabddfef1367b"

}

Property	Type	Description
`items`	array	Array containing the histogram items
`items.dimensions`	object	Object containing the dimension information
`items.dimensions.date`	string	String containing the date (format YYYY-MM-DD)
`items.series`	array	Array containing the series information
`items.series.dimension`	object	Object containing the dimensions information of the series
`items.series.dimension.category`	object	Object containing information about the category
`items.series.dimension.category.id`	string	String containing the category id
`items.series.dimension.category.name`	string	String containing the category name
`items.series.dimension.marketplace`	string	String containing the marketplace id
`items.series.metrics`	object	Object containing the series’ metrics
`items.series.metrics.volatiltity`	float	Float containing the volatility of the specific category
`request`	object	The request information object (see Request information for more information)