Endpoint advertising.spa.placements.data returns placement’s statistics for sponsored products ads (SPA).
AMALYZE Falcon API
advertising.spa.placements.data (POST)
Endpoint
Endpoint
POST advertising.spa.placements.data
Example call
Shell
|
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.placements.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
JavaScript
|
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 |
|
sorting.direction | string | The direction to sort | valid direction values |
JSON Response
JavaScript
|
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 |
{ "items": [ { "dimensions": { "placement": { "id": "others", "name": "Other on-Amazon" } }, "metrics": { "clicks": 43076, "impressions": 16042289, "clickThroughRate": 0.0026851529728706, "salesSameSKU30D": 32881.769931555, "salesAllSKU30D": 71280.749860764, "conversionsAllSKU30D": 2984, "salesPerUnitAllSKU30D": 21.051609527692 } }, { "dimensions": { "placement": { "id": "tops", "name": "Top of Search on-Amazon" } }, "metrics": { "clicks": null, "impressions": null, "clickThroughRate": null, "salesSameSKU30D": null, "salesAllSKU30D": null, "conversionsAllSKU30D": null, "salesPerUnitAllSKU30D": null } } ], "pagination": { "filtered": 2 }, "request": { "id": "3145358c-40b7-4c6d-bd84-8da26a9ee3c1", "took": 0.2383, "costs": 0, "remaining": 100000, "method": "advertising.spa.placements.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.placement | object | Object containing the placement dimension object placement definition |
request | object | The request information object (see request information object definition for more information) |
Updates / Changes
| Version | Description |