Endpoint research.product.buybox.histogram returns date histogram regarding buybox for ASIN / marketplaces
AMALYZE Falcon API
research.product.buybox.histogram (POST)
Endpoint
Method
POST research.product.buybox.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 |
curl https://falcon.amalyze.com/<VERSION>/research.product.buybox.histogram \ -X POST \ -H "X-Falcon-Token: <YOUR-TOKEN-HERE>" \ -d ' { "metrics":[ "offer" ], "filters":{ "asins": [ { "asin": "B0007OEI70", "marketplace":"A1PA6795UKMFR9" } ], "interval":"minute", "start":"2018-11-16", "end":"2018-11-16" } } ' |
JSON Payload
JavaScript
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
{ "metrics":[ "offer" ], "filters":{ "asins": [ { "asin": "B0007OEI70", "marketplace":"A1PA6795UKMFR9" } ], "interval":"minute", "start":"2018-11-16", "end":"2018-11-16" } } |
| Property | Type | Description | Further information |
filters | object | 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 | string | The interval, in which the data shall be returned | mandatory. valid intervals |
filters.asins | array | Array containing the ASINs | mandatory |
filters.asins.asin | string | String containing the ASIN | mandatory |
filters.asins.marketplace | string | String containing the marketplace | mandatory. valid marketplaces |
metrics | array | Array containing the returned metrics | mandator
|
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 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 |
{ "items": [ { "dimensions": { "date": "2018-11-16 12:38" }, "series": [ { "dimension": { "asin": "B0007OEI70", "marketplace": "A1PA6795UKMFR9", "sku": "401********32", "merchant": { "id": "A2IC3T9ETMBMOP", "name": "Die-Bücherschwester" } }, "metrics": { "price": { "offer": { "min": 13.35, "max": 13.35, "avg": 13.35 } } } } ] }, { "dimensions": { "date": "2018-11-16 12:39" }, "series": [] }, { "dimensions": { "date": "2018-11-16 12:40" }, "series": [] }, {...}, { "dimensions": { "date": "2018-11-16 12:42" }, "series": [ { "dimension": { "asin": "B0007OEI70", "marketplace": "A1PA6795UKMFR9", "sku": "HAN*****************um", "merchant": { "id": "A2IZVQ14KVU6NU", "name": "Papiertiger-Berlin" } }, "metrics": { "price": { "offer": { "min": 12.5, "max": 12.5, "avg": 12.5 } } } } ] }, {...}, { "dimensions": { "date": "2018-11-16 13:38" }, "series": [ { "dimension": { "asin": "B0007OEI70", "marketplace": "A1PA6795UKMFR9", "sku": "401********32", "merchant": { "id": "A2IC3T9ETMBMOP", "name": "Die-Bücherschwester" } }, "metrics": { "price": { "offer": { "min": 13.35, "max": 13.35, "avg": 13.35 } } } }, { "dimension": { "asin": "B0007OEI70", "marketplace": "A1PA6795UKMFR9", "sku": "HAN*****************um", "merchant": { "id": "A2IZVQ14KVU6NU", "name": "Papiertiger-Berlin" } }, "metrics": { "price": { "offer": { "min": 12.5, "max": 12.5, "avg": 12.5 } } } } ] }, {...}, { "dimensions": { "date": "2018-11-16 13:43" }, "series": [ { "dimension": { "asin": "B0007OEI70", "marketplace": "A1PA6795UKMFR9", "sku": "401********32", "merchant": { "id": "A2IC3T9ETMBMOP", "name": "Die-Bücherschwester" } }, "metrics": { "price": { "offer": { "min": 13.35, "max": 13.35, "avg": 13.35 } } } } ] }, { "dimensions": { "date": "2018-11-16 13:44" }, "series": [] }, {...}, { "dimensions": { "date": "2018-11-16 13:47" }, "series": [ { "dimension": { "asin": "B0007OEI70", "marketplace": "A1PA6795UKMFR9", "sku": "HAN*******BA", "merchant": { "id": "A3I3RGDQ7EJZHA", "name": "Bürodiscount - Online - Der kompetente Conipa® Shop aus Deutschland" } }, "metrics": { "price": { "offer": { "min": 13.26, "max": 13.26, "avg": 13.26 } } } } ] }, { "dimensions": { "date": "2018-11-16 13:48" }, "series": [ { "dimension": { "asin": "B0007OEI70", "marketplace": "A1PA6795UKMFR9", "sku": "HAN*****************um", "merchant": { "id": "A2IZVQ14KVU6NU", "name": "Papiertiger-Berlin" } }, "metrics": { "price": { "offer": { "min": 12.5, "max": 12.5, "avg": 12.5 } } } } ] }, { "dimensions": { "date": "2018-11-16 13:49" }, "series": [ { "dimension": { "asin": "B0007OEI70", "marketplace": "A1PA6795UKMFR9", "sku": "401********32", "merchant": { "id": "A2IC3T9ETMBMOP", "name": "Die-Bücherschwester" } }, "metrics": { "price": { "offer": { "min": 13.35, "max": 13.35, "avg": 13.35 } } } }, { "dimension": { "asin": "B0007OEI70", "marketplace": "A1PA6795UKMFR9", "sku": "HAN*****************um", "merchant": { "id": "A2IZVQ14KVU6NU", "name": "Papiertiger-Berlin" } }, "metrics": { "price": { "offer": { "min": 12.5, "max": 12.5, "avg": 12.5 } } } }, { "dimension": { "asin": "B0007OEI70", "marketplace": "A1PA6795UKMFR9", "sku": "HAN*******BA", "merchant": { "id": "A3I3RGDQ7EJZHA", "name": "Bürodiscount - Online - Der kompetente Conipa® Shop aus Deutschland" } }, "metrics": { "price": { "offer": { "min": 13.26, "max": 13.26, "avg": 13.26 } } } } ] }, {...}, { "dimensions": { "date": "2018-11-16 14:43" }, "series": [ { "dimension": { "asin": "B0007OEI70", "marketplace": "A1PA6795UKMFR9", "sku": "HAN*****************um", "merchant": { "id": "A2IZVQ14KVU6NU", "name": "Papiertiger-Berlin" } }, "metrics": { "price": { "offer": { "min": 12.5, "max": 12.5, "avg": 12.5 } } } } ] } ], "request": { "id": "6d7402a4-60df-4a47-8d22-630f80412948", "took": 3.2211, "costs": 1260, "remaining": 98740, "method": "research.product.buybox.histogram", "success": true, "error": { "code": null, "message": null, "hint": null } } } |
| Property | Type | Description |
items | array | Array containing the buybox histogram items |
items.dimension | object | Object containing the buybox item’s dimensions |
items.dimension.date | date | String containing the date, according to the requested interval |
items.series | array | Array containing the buybox item’s series |
items.series.dimension | object | Object containing the serie’s dimensions |
items.series.dimension.asin | string | String containing the series’ ASIN |
items.series.dimension.marketplace | string | String containing the series’ marketplace Id |
items.series.dimension.sku | string | String containing the series` SKU (obfuscated) |
items.series.dimension.merchant | object | Object containing the series’ merchant information |
items.series.dimension.merchant.id | string | String containing the series’ merchant id |
items.series.dimension.merchant.name | String containing the series’ merchant name | |
items.series.metrics | object | Object containing the series’ metrics according to the requested metrics |
items.series.metrics.price | object | Object containing the serie’s price information |
items.series.metrics.price.offer | object | Object containing the serie’s price information of the offering price |
items.series.metrics.price.offer.min | float | The serie’s minimum offering price within the dimensions date. Price `0` means that there was no buybox |
items.series.metrics.price.offer.avg | float | The serie’s average offering price within the dimensions date. Price `0` means that there was no buybox |
items.series.metrics.price.offer.max | float | The serie’s maximum offering price within the dimensions date. Price `0` means that there was no buybox |
request | object | The request information object (see request information object definition for more information) |
Updates / Changes
| Version | Description |
| 0.2.1 | new endpoint |