AMALYZE Falcon API

advertising.spa.keywords.histogram (POST)

Endpoint

Endpoint advertising.spa.keywords.histogram returns keyword’s statistics based on timeframe and timeinterval for sponsored products ads (SPA).

Endpoint

POST advertising.spa.keywords.histogram

Example call

curl https://falcon.amalyze.com/<VERSION>/advertising.spa.keywords.histogram \
-X POST \
-H "X-Falcon-Token: <YOUR-TOKEN-HERE>" \
-d '
{
	"metrics": [
		"clicks",
		"impressions"
	],
	"filters": {
		"start":"2018-07-01",
		"end":"2018-07-31",
		"marketplaceId": "A1PA6795UKMFR9",
		"campaignId": "61111111111111",
		"clicks": [
			{
				"op": "gte",
				"value": 10
			}
		],
		"interval": "week"
	}
}
'

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

curl https://falcon.amalyze.com/<VERSION>/advertising.spa.keywords.histogram \

-X POST \

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

-d '

{

"metrics": [

"clicks",

"impressions"

],

"filters": {

"start":"2018-07-01",

"end":"2018-07-31",

"marketplaceId": "A1PA6795UKMFR9",

"campaignId": "61111111111111",

"clicks": [

{

"op": "gte",

"value": 10

}

],

"interval": "week"

}

'

JSON Payload

{
	"metrics": [
		"clicks",
		"impressions"
	],
	"filters": {
		"start":"2018-07-01",
		"end":"2018-07-31",
		"marketplaceId": "A1PA6795UKMFR9",
		"campaignId": "61111111111111",
		"clicks": [
			{
				"op": "gte",
				"value": 10
			}
		],
		"interval": "week"
	}
}

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

{

"metrics": [

"clicks",

"impressions"

],

"filters": {

"start":"2018-07-01",

"end":"2018-07-31",

"marketplaceId": "A1PA6795UKMFR9",

"campaignId": "61111111111111",

"clicks": [

{

"op": "gte",

"value": 10

}

],

"interval": "week"

}

Property	Type	Description	Further information
`filters`	object	The object containing the filter information
`filters.start`	date	Sart date in format YYYY-MM-DD	mandatory
`filters.end`	date	End date in format YYYY-MM-DD	mandatory
`filters.interval`	date	The interval, in which the data shall be returned	mandatory (see valid intervals)
`filters.adgroup`	string	Filters for adgroup dimension	optional. Usage and valid filter for adgroup dimension
`filters.advertiser`	string	Filters for advertiser dimension	optional. Usage and valid filter for advertiser dimension
`filters.campaign`	string	Filters for campaign dimension	optional. Usage and valid filter for campaign dimension
`filters.keyword`	string	Filters for keyword dimension	optional. Usage and valid filter for keyword dimension
`filters.marketplace`	string	Filters for marketplace dimension	optional. Usage and valid filter for marketplace dimension
`filters.metrics`	string	Filter for metrics	optional. Usage and valid metrics to filter
`metrics`	array	Array containing the metrics to be returned	optional. Usage and valid metrics to return

JSON Response

{
    "items": [
        {
            "dimensions": {
                "date": "2018-26"
            },
            "metrics": {
                "clicks": 446,
                "impressions": 303174
            }
        },
        {
            "dimensions": {
                "date": "2018-27"
            },
            "metrics": {
                "clicks": 1717,
                "impressions": 1362558
            }
        },
        {
            "dimensions": {
                "date": "2018-28"
            },
            "metrics": {
                "clicks": 1405,
                "impressions": 1204506
            }
        },
        {
            "dimensions": {
                "date": "2018-29"
            },
            "metrics": {
                "clicks": 1702,
                "impressions": 1625674
            }
        },
        {
            "dimensions": {
                "date": "2018-30"
            },
            "metrics": {
                "clicks": 2382,
                "impressions": 2271674
            }
        },
        {
            "dimensions": {
                "date": "2018-31"
            },
            "metrics": {
                "clicks": 892,
                "impressions": 865996
            }
        }
    ],
    "request": {
        "id": "90d42bc4-ef19-48f7-8ea3-c640a2590d5f",
        "took": 1.2383,
        "costs": 0,
        "remaining": 100000,
        "method": "advertising.spa.keywords.histogram",
        "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

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

{

"items": [

{

"dimensions": {

"date": "2018-26"

},

"metrics": {

"clicks": 446,

"impressions": 303174

}

},

{

"dimensions": {

"date": "2018-27"

},

"metrics": {

"clicks": 1717,

"impressions": 1362558

}

},

{

"dimensions": {

"date": "2018-28"

},

"metrics": {

"clicks": 1405,

"impressions": 1204506

}

},

{

"dimensions": {

"date": "2018-29"

},

"metrics": {

"clicks": 1702,

"impressions": 1625674

}

},

{

"dimensions": {

"date": "2018-30"

},

"metrics": {

"clicks": 2382,

"impressions": 2271674

}

},

{

"dimensions": {

"date": "2018-31"

},

"metrics": {

"clicks": 892,

"impressions": 865996

}

],

"request": {

"id": "90d42bc4-ef19-48f7-8ea3-c640a2590d5f",

"took": 1.2383,

"costs": 0,

"remaining": 100000,

"method": "advertising.spa.keywords.histogram",

"success": true,

"error": {

"code": null,

"message": null,

"hint": null

}

Property	Type	Description
`items`	array	Array containing the merchant / vendor items
`metrics`	object	Object containing the requested metrics
`dimensions`	object	Object containing the dimensions
`dimensions.date`	date	The date
`request`	object	The request information object (see request information object definition for more information)