AMALYZE Falcon API

advertising.spa.asins.histogram (POST)

Endpoint

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

Method

POST advertising.spa.asins.histogram

Example call

curl https://falcon.amalyze.com/<VERSION>/advertising.spa.asins.histogram \
-X POST \
-H "X-Falcon-Token: <YOUR-TOKEN-HERE>" \
-d '
{
	"metrics": [
		"clicks",
		"impressions",
		"salesOtherSKU30D"
	],
	"filters": {
		"start":"2018-08-01",
		"end":"2018-08-31",
		"interval": "week"
	}
}'

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

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

-X POST \

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

-d '

{

"metrics": [

"clicks",

"impressions",

"salesOtherSKU30D"

],

"filters": {

"start":"2018-08-01",

"end":"2018-08-31",

"interval": "week"

}

}'

JSON Payload

{
	"metrics": [
		"clicks",
		"impressions",
		"salesOtherSKU30D"
	],
	"filters": {
		"start":"2018-08-01",
		"end":"2018-08-31",
		"interval": "week"
	}
}

1

2

3

4

5

6

7

8

9

10

11

12

{

"metrics": [

"clicks",

"impressions",

"salesOtherSKU30D"

],

"filters": {

"start":"2018-08-01",

"end":"2018-08-31",

"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.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.metrics`	string	Filter for metrics	optional. `salesOtherSKU1D` `salesOtherSKU7D` `salesOtherSKU14D` `salesOtherSKU30D` `unitsOtherSKU1D` `unitsOtherSKU7D` `unitsOtherSKU14D` `unitsOtherSKU30D` `salesPerUnitOtherSKU1D` `salesPerUnitOtherSKU7D` `salesPerUnitOtherSKU14D` `salesPerUnitOtherSKU30D`
`metrics`	array	Array containing the metrics to be returned	optional. `salesOtherSKU1D` `salesOtherSKU7D` `salesOtherSKU14D` `salesOtherSKU30D` `unitsOtherSKU1D` `unitsOtherSKU7D` `unitsOtherSKU14D` `unitsOtherSKU30D` `salesPerUnitOtherSKU1D` `salesPerUnitOtherSKU7D` `salesPerUnitOtherSKU14D` `salesPerUnitOtherSKU30D`

JSON Response

{
    "items": [
        {
            "dimensions": {
                "date": "2018-31"
            },
            "metrics": {
                "salesOtherSKU30D": 398148.0394609,
                "unitsOtherSKU7D": 18340,
                "salesPerUnitOtherSKU30D": 21.098407051078
            }
        },
        {
            "dimensions": {
                "date": "2018-32"
            },
            "metrics": {
                "salesOtherSKU30D": 441793.97920597,
                "unitsOtherSKU7D": 21683,
                "salesPerUnitOtherSKU30D": 20.352604192471
            }
        },
        {
            "dimensions": {
                "date": "2018-33"
            },
            "metrics": {
                "salesOtherSKU30D": 68588.659966707,
                "unitsOtherSKU7D": 3290,
                "salesPerUnitOtherSKU30D": 20.847617011157
            }
        }
    ],
    "request": {
        "id": "27462ac9-238b-4797-8792-92da1e088aec",
        "took": 0.2331,
        "costs": 0,
        "remaining": 100000,
        "method": "advertising.spa.asins.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

{

"items": [

{

"dimensions": {

"date": "2018-31"

},

"metrics": {

"salesOtherSKU30D": 398148.0394609,

"unitsOtherSKU7D": 18340,

"salesPerUnitOtherSKU30D": 21.098407051078

}

},

{

"dimensions": {

"date": "2018-32"

},

"metrics": {

"salesOtherSKU30D": 441793.97920597,

"unitsOtherSKU7D": 21683,

"salesPerUnitOtherSKU30D": 20.352604192471

}

},

{

"dimensions": {

"date": "2018-33"

},

"metrics": {

"salesOtherSKU30D": 68588.659966707,

"unitsOtherSKU7D": 3290,

"salesPerUnitOtherSKU30D": 20.847617011157

}

],

"request": {

"id": "27462ac9-238b-4797-8792-92da1e088aec",

"took": 0.2331,

"costs": 0,

"remaining": 100000,

"method": "advertising.spa.asins.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)