Endpoint advertising.spa.searchterms.histogram returns keyword’s statistics based on timeframe and timeinterval for sponsored products ads (SPA).
AMALYZE Falcon API
advertising.spa.searchterms.histogram (POST)
Endpoint
Method
POST advertising.spa.searchterms.histogram
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 |
curl https://falcon.amalyze.com/<VERSION>/advertising.spa.searchterms.histogram \ -X POST \ -H "X-Falcon-Token: <YOUR-TOKEN-HERE>" \ -d ' { "metrics": [ "clicks", "impressions" ], "filters": { "start":"2018-07-01", "end":"2018-07-31", "marketplaceId": "A1PA6795UKMFR9", "campaignId": "61111111111111", "clicks": [ { "op": "gte", "value": 10 } ], "interval": "week", "searchterm": "iphone" } } ' |
JSON Payload
Shell
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
{ "metrics": [ "clicks", "impressions" ], "filters": { "start":"2018-07-01", "end":"2018-07-31", "marketplaceId": "A1PA6795UKMFR9", "campaignId": "61111111111111", "clicks": [ { "op": "gte", "value": 10 } ], "interval": "week", "searchterm": "iphone" } } |
| 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.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.searchterm | string | Filters for a specific searchterm | optional |
filters.marketplace | string | Filters for marketplace dimension | optional. Usage and valid filter for marketplace 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 |
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 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
{ "items": [ { "dimensions": { "date": "2018-26" }, "metrics": { "clicks": 94418, "impressions": 6777246 } }, { "dimensions": { "date": "2018-27" }, "metrics": { "clicks": 562281, "impressions": 40524764 } }, { "dimensions": { "date": "2018-28" }, "metrics": { "clicks": 602132, "impressions": 43605080 } }, { "dimensions": { "date": "2018-29" }, "metrics": { "clicks": 644658, "impressions": 55306826 } }, { "dimensions": { "date": "2018-30" }, "metrics": { "clicks": 614528, "impressions": 45989730 } }, { "dimensions": { "date": "2018-31" }, "metrics": { "clicks": 197127, "impressions": 15456445 } } ], "request": { "id": "45fbfbd5-e0e9-4425-921b-f76324830ef2", "took": 1.5389, "costs": 0, "remaining": 100000, "method": "advertising.spa.searchterms.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) |
Updates / Changes
| Version | Description |