AMALYZE Falcon API

pulse.serps.searchvolume.histogram (POST)

Endpoint

Endpoint pulse.serps.searchvolue.histogram returns the (relative) searchvolume for a marketplace and/or several keywords.

Method

POST pulse.serps.searchvolume.histogram

Example call

curl https://falcon.amalyze.com/<VERSION>/pulse.serps.categories.histogram \
-X POST \
-H "X-Falcon-Token: <YOUR-TOKEN-HERE>" \
-d '
{
    "filters": {
        "marketplace": "A1PA6795UKMFR9",
        "keywords": [
            "*maske*"
        ],
        "start": "2019-11-01",
        "end": "2020-03-30",
        "interval": "day"
    }
}
'

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

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

-X POST \

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

-d '

{

"filters": {

"marketplace": "A1PA6795UKMFR9",

"keywords": [

"*maske*"

],

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

"end": "2020-03-30",

"interval": "day"

}

'

JSON Payload

{
    "filters": {
        "marketplace": "A1PA6795UKMFR9",
        "keywords": [
            "*maske*"
        ],
        "start": "2019-11-01",
        "end": "2020-03-30",
        "interval": "day"
    }
}

1

2

3

4

5

6

7

8

9

10

11

{

"filters": {

"marketplace": "A1PA6795UKMFR9",

"keywords": [

"*maske*"

],

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

"end": "2020-03-30",

"interval": "day"

}

Property	Type	Description	Further information	Version
`filters`	object	Object containing the filter settings		0.8.0
`filters.marketplace`	string	String containing the marketplace id	valid marketplaces ids	0.8.0
`filters.keywords`	array	Array containing specifcic keywords	Optional, keywords support wildcads	0.8.0
`filters.start`	string	String containing the start date (YYYY-MM-DD)		0.8.0
`filters.end`	string	String containing the end date (YYYY-MM-DD)		0.8.0
`filters.interval`	string	String containing the interval	valid intervals	0.8.0

JSON Response

{
    "items": [
        {
            "dimensions": {
                "date": "2020-02-01"
            },
            "series": [
                {
                    "dimension": {
                        "keyword": "knoblauchpresse",
                        "marketplace": "A1PA6795UKMFR9"
                    },
                    "metrics": {
                        "trend": 0.35695119847482,
                        "searchterms": 1
                    }
                },
                {
                    "dimension": {
                        "keyword": "*zwerg*",
                        "marketplace": "A1PA6795UKMFR9"
                    },
                    "metrics": {
                        "trend": 0.58193847670991,
                        "searchterms": 17
                    }
                }
            ]
        },
        {
            "dimensions": {
                "date": "2020-02-02"
            },
            "series": [
                {
                    "dimension": {
                        "keyword": "knoblauchpresse",
                        "marketplace": "A1PA6795UKMFR9"
                    },
                    "metrics": {
                        "trend": 0.43948012358262,
                        "searchterms": 1
                    }
                },
                {
                    "dimension": {
                        "keyword": "*zwerg*",
                        "marketplace": "A1PA6795UKMFR9"
                    },
                    "metrics": {
                        "trend": 0.63664115369111,
                        "searchterms": 16
                    }
                }
            ]
        },
        {...},
        {...},
        {...},
        {...},
        {...},
        {
            "dimensions": {
                "date": "2020-02-28"
            },
            "series": [
                {
                    "dimension": {
                        "keyword": "knoblauchpresse",
                        "marketplace": "A1PA6795UKMFR9"
                    },
                    "metrics": {
                        "trend": 0.31023447110661,
                        "searchterms": 1
                    }
                },
                {
                    "dimension": {
                        "keyword": "*zwerg*",
                        "marketplace": "A1PA6795UKMFR9"
                    },
                    "metrics": {
                        "trend": 0.022713432589582,
                        "searchterms": 1
                    }
                }
            ]
        }
    ],
    "request": {
        "id": "30a1f5ae-e14f-435a-88bb-f395c009eb7d",
        "took": 0.9433,
        "costs": 0,
        "remaining": 100000,
        "method": "pulse.serps.searchvolume.histogram",
        "success": true,
        "error": {
            "code": null,
            "message": null,
            "hint": null
        },
        "cache": {
            "generated": 1584983270,
            "cached": false,
            "id": "059c2277aa8d45171ce55342c21d5ec4"
        }
    }
}

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

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

{

"items": [

{

"dimensions": {

"date": "2020-02-01"

},

"series": [

{

"dimension": {

"keyword": "knoblauchpresse",

"marketplace": "A1PA6795UKMFR9"

},

"metrics": {

"trend": 0.35695119847482,

"searchterms": 1

}

},

{

"dimension": {

"keyword": "*zwerg*",

"marketplace": "A1PA6795UKMFR9"

},

"metrics": {

"trend": 0.58193847670991,

"searchterms": 17

}

]

},

{

"dimensions": {

"date": "2020-02-02"

},

"series": [

{

"dimension": {

"keyword": "knoblauchpresse",

"marketplace": "A1PA6795UKMFR9"

},

"metrics": {

"trend": 0.43948012358262,

"searchterms": 1

}

},

{

"dimension": {

"keyword": "*zwerg*",

"marketplace": "A1PA6795UKMFR9"

},

"metrics": {

"trend": 0.63664115369111,

"searchterms": 16

}

]

},

{...},

{

"dimensions": {

"date": "2020-02-28"

},

"series": [

{

"dimension": {

"keyword": "knoblauchpresse",

"marketplace": "A1PA6795UKMFR9"

},

"metrics": {

"trend": 0.31023447110661,

"searchterms": 1

}

},

{

"dimension": {

"keyword": "*zwerg*",

"marketplace": "A1PA6795UKMFR9"

},

"metrics": {

"trend": 0.022713432589582,

"searchterms": 1

}

]

}

],

"request": {

"id": "30a1f5ae-e14f-435a-88bb-f395c009eb7d",

"took": 0.9433,

"costs": 0,

"remaining": 100000,

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

"success": true,

"error": {

"code": null,

"message": null,

"hint": null

},

"cache": {

"generated": 1584983270,

"cached": false,

"id": "059c2277aa8d45171ce55342c21d5ec4"

}

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.keyword`	string	String containing the keyword(s) requested
`items.series.dimension.marketplace`	string	String containing the marketplace ID
`items.series.metrics`	object	Object containing the series’ metrics
`items.series.metrics.trend`	float	Float containing the searchvolume trend for this keyword(s) within the marketplace
`items.series.metrics.searchterms`	integer	Integer containing the number of keywords (if using wildcards)
`request`	object	The request information object (see Request information for more information)