AMALYZE Falcon API

advertising.spa.campaigns.data (POST)

Endpoint

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

Method

POST advertising.spa.campaigns.data

Example call

curl https://falcon.amalyze.com/<VERSION>/advertising.spa.campaigns.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
			}
		]
	},
	"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

curl https://falcon.amalyze.com/<VERSION>/advertising.spa.campaigns.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

}

]

},

"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
			}
		]
	},
	"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

{

"filters":{

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

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

"marketplaceId": "A1PA6795UKMFR9",

"clicks": [

{

"op": "gte",

"value": 10

}

]

},

"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.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.marketplace`	string	Filters for marketplace dimension	optional. Usage and valid filter for marketplace dimension
`filters.placement`	string	Filters for placement dimension	optional. Usage and valid filter for placement 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` `campaignName` `campaignTargeting` `campaignBidPlus` `campaignState` `campaignAmalyzeManaged` `campaignAmalyzeTargeting` `campaignAmalyzeOptimization` `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": {
                    "type": "seller",
                    "id": "AXXXXXXXXXXXXX",
                    "name": "Sample advertiser name"
                },
                "marketplace": {
                    "id": "A1PA6795UKMFR9",
                    "name": "amazon.de"
                },
                "campaign": {
                    "id": "63531111111111",
                    "name": "Sample campaign",
                    "type": "sponsoredProducts",
                    "targeting": "auto",
                    "bidPlus": true,
                    "dailyBudget": 1000,
                    "start": "2017-01-03T00:00:00+00:00",
                    "end": null,
                    "state": "enabled",
                    "amalyzeManaged": false,
                    "amalyzeTargeting": null,
                    "amalyzeOptimization": null
                }
            },
            "metrics": {
                "clicks": 448,
                "impressions": 412769,
                "clickThroughRate": 0.0010853528244611,
                "salesSameSKU30D": 364.86999511719,
                "salesAllSKU30D": 1139.7600097656,
                "conversionsAllSKU30D": 25,
                "salesPerUnitAllSKU30D": 43.836923452524
            }
        }
    ],
    "pagination": {
        "filtered": 965
    },
    "request": {
        "id": "9e09a67a-2264-4501-a34b-d51d389b2ff3",
        "took": 1.023,
        "costs": 0,
        "remaining": 100000,
        "method": "advertising.spa.campaigns.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

{

"items": [

{

"dimensions": {

"advertiser": {

"type": "seller",

"id": "AXXXXXXXXXXXXX",

"name": "Sample advertiser name"

},

"marketplace": {

"id": "A1PA6795UKMFR9",

"name": "amazon.de"

},

"campaign": {

"id": "63531111111111",

"name": "Sample campaign",

"type": "sponsoredProducts",

"targeting": "auto",

"bidPlus": true,

"dailyBudget": 1000,

"start": "2017-01-03T00:00:00+00:00",

"end": null,

"state": "enabled",

"amalyzeManaged": false,

"amalyzeTargeting": null,

"amalyzeOptimization": null

}

},

"metrics": {

"clicks": 448,

"impressions": 412769,

"clickThroughRate": 0.0010853528244611,

"salesSameSKU30D": 364.86999511719,

"salesAllSKU30D": 1139.7600097656,

"conversionsAllSKU30D": 25,

"salesPerUnitAllSKU30D": 43.836923452524

}

],

"pagination": {

"filtered": 965

},

"request": {

"id": "9e09a67a-2264-4501-a34b-d51d389b2ff3",

"took": 1.023,

"costs": 0,

"remaining": 100000,

"method": "advertising.spa.campaigns.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
`request`	object	The request information object (see request information object definition for more information)