AMALYZE Falcon API

advertising.spa.advertisers.data (POST)

Endpoint

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

Method

POST advertising.spa.advertisers.data

Example call

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

}

]

},

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

}

]

},

"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.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	`advertiserName`: sort by advertiser’s name `advertiserType`: sort by advertiser type `advertiserId`: sort by advertiser id `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": "A2XXXXXXXXXXXX",
                    "name": "Sample advertiser name"
                }
            },
            "metrics": {
                "clicks": 4497,
                "impressions": 1349038,
                "clickThroughRate": 0.0033334865289191,
                "salesSameSKU30D": 4022.9200077057,
                "salesAllSKU30D": 7024.5299930573,
                "conversionsAllSKU30D": 260,
                "salesPerUnitAllSKU30D": 26.60806815552
            }
        }
    ],
    "pagination": {
        "filtered": 12
    },
    "request": {
        "id": "ea45ab26-e79a-4f68-8aad-1a99d6d83af3",
        "took": 0.2156,
        "costs": 0,
        "remaining": 100000,
        "method": "advertising.spa.advertisers.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

{

"items": [

{

"dimensions": {

"advertiser": {

"type": "seller",

"id": "A2XXXXXXXXXXXX",

"name": "Sample advertiser name"

}

},

"metrics": {

"clicks": 4497,

"impressions": 1349038,

"clickThroughRate": 0.0033334865289191,

"salesSameSKU30D": 4022.9200077057,

"salesAllSKU30D": 7024.5299930573,

"conversionsAllSKU30D": 260,

"salesPerUnitAllSKU30D": 26.60806815552

}

],

"pagination": {

"filtered": 12

},

"request": {

"id": "ea45ab26-e79a-4f68-8aad-1a99d6d83af3",

"took": 0.2156,

"costs": 0,

"remaining": 100000,

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