AMALYZE Falcon API

advertising.spa.searchterms.data (POST)

Endpoint

Endpoint advertising.spa.searchterms.data returns searchterms’s statistics for sponsored products ads (SPA).

Method

POST advertising.spa.searchterms.data

Example call

curl https://falcon.amalyze.com/<VERSION>/advertising.spa.searchterms.data \
-X POST \
-H "X-Falcon-Token: <YOUR-TOKEN-HERE>" \
-d '
{
	"filters":{
		"start":"2018-07-31",
		"end":"2018-07-31",
		"marketplaceId": "A1PA6795UKMFR9",
		"clicks": [
			{
				"op": "gte",
				"value": 10
			}
		],
		"campaignId": "211111111111111"
	},
	"metrics": [
		"clicks",
		"impressions",
		"clickThroughRate",
		"salesSameSKU30D",
		"salesAllSKU30D",
		"conversionsAllSKU30D",
		"salesPerUnitAllSKU30D"
	],
	"pagination":{
		"page":1,
		"size":1
	},"sorting":[
		{
			"direction":"desc",
			"column": "impressions"
		}
	]

}
'

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

curl https://falcon.amalyze.com/<VERSION>/advertising.spa.searchterms.data \

-X POST \

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

-d '

{

"filters":{

"start":"2018-07-31",

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

"marketplaceId": "A1PA6795UKMFR9",

"clicks": [

{

"op": "gte",

"value": 10

}

],

"campaignId": "211111111111111"

},

"metrics": [

"clicks",

"impressions",

"clickThroughRate",

"salesSameSKU30D",

"salesAllSKU30D",

"conversionsAllSKU30D",

"salesPerUnitAllSKU30D"

],

"pagination":{

"page":1,

"size":1

},"sorting":[

{

"direction":"desc",

"column": "impressions"

}

]

}

'

JSON Payload

{
	"filters":{
		"start":"2018-07-31",
		"end":"2018-07-31",
		"marketplaceId": "A1PA6795UKMFR9",
		"clicks": [
			{
				"op": "gte",
				"value": 10
			}
		],
		"campaignId": "211111111111111"
	},
	"metrics": [
		"clicks",
		"impressions",
		"clickThroughRate",
		"salesSameSKU30D",
		"salesAllSKU30D",
		"conversionsAllSKU30D",
		"salesPerUnitAllSKU30D"
	],
	"pagination":{
		"page":1,
		"size":1
	},"sorting":[
		{
			"direction":"desc",
			"column": "impressions"
		}
	]

}

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

{

"filters":{

"start":"2018-07-31",

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

"marketplaceId": "A1PA6795UKMFR9",

"clicks": [

{

"op": "gte",

"value": 10

}

],

"campaignId": "211111111111111"

},

"metrics": [

"clicks",

"impressions",

"clickThroughRate",

"salesSameSKU30D",

"salesAllSKU30D",

"conversionsAllSKU30D",

"salesPerUnitAllSKU30D"

],

"pagination":{

"page":1,

"size":1

},"sorting":[

{

"direction":"desc",

"column": "impressions"

}

]

}

Property	Type	Description	Further information
`pagination`	object	The object containing the pagination information	pagination object definition
`filters`	object	The object containing the filter information
`filters.start`	date	String containing the start date	mandatory
`filters.end`	date	String containing the end date	mandatory
`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.searchterm`	string	Filters for searchterm dimension	optional. Usage and valid filter for searchterm 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
`sorting`	array	Array containing the sorting information
`sorting.column`	string	The column to sort	`advertiserId` `marketplaceId` `campaignId` `adgroupId` `keywordId`: sort by keyword’s id `keyword`: sort by keyword `keywordMatchType`sort by keyword’s match type `keywordState`sort by keyword state `keywordBid`sort by keyword bid `searchterm` `metric`: sort by metrics (see Usage and valid metrics to sort)
`sorting.direction`	string	The direction to sort	valid direction values

JSON Response

{
    "items": [
        {
            "dimensions": {
                "advertiser": {
                    "id": "AXXXXXXXXXXXXX",
                    "name": "Sample advertiser"
                },
                "marketplace": {
                    "id": "A1PA6795UKMFR9",
                    "name": "amazon.de"
                },
                "campaign": {
                    "id": "211111111111111",
                    "name": "Sample campaign",
                    "type": "sponsoredProducts",
                    "targeting": "manual",
                    "bidPlus": true,
                    "dailyBudget": 1000,
                    "start": "2016-05-26T00:00:00+00:00",
                    "end": null,
                    "state": "enabled",
                    "amalyzeManaged": false,
                    "amalyzeTargeting": null,
                    "amalyzeOptimization": null
                },
                "adgroup": {
                    "id": "211111111111111",
                    "name": "Sample adgroup",
                    "state": "enabled",
                    "defaultBid": 0.6
                },
                "keyword": {
                    "id": "411111111111",
                    "keyword": "herrenuhren",
                    "matchtType": "broad",
                    "state": "enabled",
                    "bid": null
                },
                "searchterm": "herrenuhr"
            },
            "metrics": {
                "clicks": 43,
                "impressions": 10452,
                "clickThroughRate": 0.0041140451588213,
                "salesSameSKU30D": 0,
                "salesAllSKU30D": 0,
                "conversionsAllSKU30D": 0,
                "salesPerUnitAllSKU30D": null
            }
        }
    ],
    "pagination": {
        "filtered": 17
    },
    "request": {
        "id": "e42a257c-b4a7-4a00-a686-128af4e6c523",
        "took": 1.0196,
        "costs": 0,
        "remaining": 100000,
        "method": "advertising.spa.searchterms.data",
        "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

{

"items": [

{

"dimensions": {

"advertiser": {

"id": "AXXXXXXXXXXXXX",

"name": "Sample advertiser"

},

"marketplace": {

"id": "A1PA6795UKMFR9",

"name": "amazon.de"

},

"campaign": {

"id": "211111111111111",

"name": "Sample campaign",

"type": "sponsoredProducts",

"targeting": "manual",

"bidPlus": true,

"dailyBudget": 1000,

"start": "2016-05-26T00:00:00+00:00",

"end": null,

"state": "enabled",

"amalyzeManaged": false,

"amalyzeTargeting": null,

"amalyzeOptimization": null

},

"adgroup": {

"id": "211111111111111",

"name": "Sample adgroup",

"state": "enabled",

"defaultBid": 0.6

},

"keyword": {

"id": "411111111111",

"keyword": "herrenuhren",

"matchtType": "broad",

"state": "enabled",

"bid": null

},

"searchterm": "herrenuhr"

},

"metrics": {

"clicks": 43,

"impressions": 10452,

"clickThroughRate": 0.0041140451588213,

"salesSameSKU30D": 0,

"salesAllSKU30D": 0,

"conversionsAllSKU30D": 0,

"salesPerUnitAllSKU30D": null

}

],

"pagination": {

"filtered": 17

},

"request": {

"id": "e42a257c-b4a7-4a00-a686-128af4e6c523",

"took": 1.0196,

"costs": 0,

"remaining": 100000,

"method": "advertising.spa.searchterms.data",

"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.advertiser`	object	Object containing the advertiser dimension object advertiser definition
`dimensions.marketplace`	object	Object containing the marketplace dimension object marketplace definition
`dimensions.campaign`	object	Object containing the campaign dimension object campaign definition
`dimensions.adgroup`	object	Object containing the adgroup dimension object adgroup definition
`dimensions.keyword`	object	Object containing the keyword dimension object keyword definition
`dimension.searchterm`	string	String containing the searchterm
`request`	object	The request information object (see request information object definition for more information)