Endpoint portfolios.overview
returns the current overview for a specific portfolio by it’s id.
AMALYZE Falcon API
portfolios.overview (POST)
Endpoint
Method
POST portfolios.overview
Example call
Shell
1 2 3 4 5 6 7 8 9 |
curl https://falcon.amalyze.com/<VERSION>/portfolios.overview \ -X POST \ -H "X-Falcon-Token: <YOUR-TOKEN-HERE>" \ -d ' { "portfolio": "3551dab3631533eb61332d419e1b3552", "marketplace": "A1PA6795UKMFR9" } ' |
JSON Payload
JavaScript
1 2 3 4 |
{ "portfolio": "3551dab3631533eb61332d419e1b3552", "marketplace": "A1PA6795UKMFR9" } |
Property | Type | Description | Further information | Version |
marketplace | string | String containing the marketplace id | valid marketplaces ids | 0.4.0 |
portfolio | string | String containing the portfolios id | 0.4.0 |
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 |
{ "items": [ { "score": 100, "type": "brand", "name": "samplePortfolio", "marketplace": { "id": "A1PA6795UKMFR9", "name": "amazon.de" }, "total": { "current": 22162, "history": [ 22158, 22162 ] }, "visibles": { "total": { "current": 17969, "history": [ 17969, 17969 ] }, "rate": { "current": 0.81, "history": [ 0.81, 0.81 ] } }, "prime": { "total": { "current": 11964, "history": [ 12022, 11964 ] }, "rate": { "current": 0.67, "history": [ 0.62, 0.67 ] } }, "bsr": { "main": { "rank": { "avg": { "current": 119538.83, "history": [ 130334.5, 119538.83 ] } } } }, "offers": { "avg": { "current": 1, "history": [ 1, 1 ] } }, "buybox": { "total": { "current": 17667, "history": [ 21771, 17667 ] }, "amount": { "avg": { "current": 8.88, "history": [ 9.13, 8.88 ] } }, "rate": { "current": 0.98, "history": [ 0.98, 0.98 ] }, "merchants": { "current": null, "history": [ 11, 11 ] } }, "subscriptions": { "total": { "current": 0, "history": [ 0, 0 ] }, "rate": { "current": 0, "history": [ 0, 0 ] } }, "types": { "standalones": { "total": { "current": 316, "history": [ 316, 316 ] }, "rate": { "current": 0.02, "history": [ 0.02, 0.02 ] } }, "variations": { "total": { "current": 17653, "history": [ 17653, 17653 ] }, "rate": { "current": 0.98, "history": [ 0.98, 0.98 ] } } }, "bestsellers": { "total": { "current": 8, "history": [ 9, 8 ] }, "rate": { "current": 0, "history": [ 0, 0 ] } }, "rating": { "all": { "avg": { "current": 3.34, 3.25, 3.34 ] } }, "exists": { "avg": { "current": 3.86, "history": [ 3.82, 3.86 ] } } }, "reviews": { "all": { "avg": { "current": 34.51, "history": [ 32.37, 34.51 ] } }, "exists": { "avg": { "current": 39.87, "history": [ 38.07, 39.87 ] } } }, "plus": { "total": { "current": 23, "history": [ 22, 23 ] }, "rate": { "current": 0, "history": [ 0, 0 ] } }, "rankings": { "organic": { "position": { "avg": { "current": 47.31, "history": [ 47.22, 47.31 ] } }, "rankings": { "avg": { "current": 164.25, "history": [ 159.51, 164.25 ] } }, "choices": { "avg": { "current": 1.95, "history": [ 1.52, 1.95 ] } } } }, "promotions": { "total": { "current": 402, "history": [ 4236, 402 ] }, "rate": { "current": 0.02, "history": [ 0.19, 0.02 ] } }, "stats": { "as": { "avg": { "current": 1.55, "history": [ 1.52, 1.55 ] } } }, "timestamps": { "create": "2019-04-08T09:27:26+00:00", "update": "2019-04-09T19:57:44+00:00" } } ], "filtered": 1, "request": { "id": "defa24be-10c4-4219-8086-63fdfbe5587a", "took": 0.2434, "costs": 0, "remaining": 100000, "method": "portfolios", "success": true, "error": { "code": null, "message": null, "hint": null }, "cache": { "generated": 1554840063, "cached": false, "id": null } } } |
Property | Type | Description | Version |
items | array | Array containing the portfolio items | 0.4.0 |
items.score | float | Internal match score | 0.4.0 |
items.type | string | Portfolios type
| 0.4.0 |
items.name | string | Portfolios name | 0.4.0 |
items.marketplace | object | Object containing the marketplace information | 0.4.0 |
items.marketplace.id | string | The marketplace ID for the returned product (see marketplace definitions for more informations. | 0.4.0 |
items.marketplace.name | string | Marketplace name | 0.4.0 |
items.total | object | Object containing information about the total number of ASINs within the portfolio | 0.4.0 |
items.total.current | integer | The number of total ASINs within the portfolio | 0.4.0 |
items.total.history | array | Array containing the last 10 items of items.total.current | 0.4.0 |
items.visibles | object | Object containing information about the visible ASINs within the portfolio | 0.4.0 |
items.visibles.total | object | Object containing information about the number of visible ASINs within the portfolio | 0.4.0 |
items.visibles.total.current | integer | Number of visible ASINs within the portfolio | 0.4.0 |
items.visibles.total.history | array | Array containing the last 10 items of items.visibles.total.current | 0.4.0 |
items.visibles.rate | object | Object containing information about the rate of visible ASINs within the portfolio | 0.4.0 |
items.visibles.rate.current | float | Rate of visible ASINs within the portfolio | 0.4.0 |
items.visibles.rate.history | array | Array containing the last 10 items of items.visibles.rate.current | 0.4.0 |
items.prime | object | Object containing information about the visible ASINs within the portfolio, available as Prime | 0.4.0 |
items.prime.total | object | Object containing information about the number of visible ASINs within the portfolio, available as Prime | 0.4.0 |
items.prime.total.current | integer | Number of visible ASIns within the portfolio available as Prime | 0.4.0 |
items.prime.total.history | array | Array containing the last 10 items of items.prime.total.current . | 0.4.0 |
items.prime.rate | object | Object containing information about the rate of visible ASINs within the portfolio, available as Prime | 0.4.0 |
items.prime.rate.current | float | Rate of visible ASIns within the portfolio available as Prime | 0.4.0 |
items.prime.rate.history | array | Array containing the last 10 items of items.prime.rate.current . | 0.4.0 |
items.bsr | object | Object containing information about the BSRs of visible ASINs within the portfolio | 0.4.0 |
items.bsr.main | object | Object containing information about the (main category) BSRs of visible ASINs within the portfolio | 0.4.0 |
items.bsr.main.rank | object | 0.4.0 | |
items.bsr.main.rank.avg | object | Object containing information about the average (main category) BSRs of visible ASINs within the portfolio | 0.4.0 |
items.bsr.main.rank.avg.current | float | Average (main category) BSRs of visible ASINs within the portfolio | 0.4.0 |
items.bsr.main.rank.avg.history | array | Array containing the last 10 items of items.bsr.main.rank.avg.history . | 0.4.0 |
items.offers | object | Object containing about the number of offers of visible ASINs within the portfolio | 0.4.0 |
items.offers.avg | object | Object containing about the average number of offers of visible ASINs within the portfolio | 0.4.0 |
items.offers.avg.current | Integer | Number of average offers of visible ASINs within the portfolio | 0.4.0 |
items.offers.avg.history | array | Array containing the last 10 items of items.offers.avg.history . | 0.4.0 |
items.buybox | object | Object containing information about visible ASINs within the portfolio, having a buybox | 0.4.0 |
items.buybox.total | object | Object containing information about the number of visible ASINs within the portfolio, having a buybox | 0.4.0 |
items.buybox.total.current | integer | Number of visible ASINs within the portfolio, having a buybox | 0.4.0 |
items.buybox.total.history | array | Array containing the last 10 items of items.buybox.total.history . | 0.4.0 |
items.buybox.amount | object | Object containing information about the amount of visible ASINs within the portfolio, having a buybox | 0.4.0 |
items.buybox.amount.avg | object | Object containing information about the average amount of visible ASINs within the portfolio, having a buybox | 0.4.0 |
items.buybox.amount.avg.current | float | Average amount of visible ASINs within the portfolio, having a buybox | 0.4.0 |
items.buybox.amount.avg.history | array | Array containing the last 10 items of items.buybox.amount.avg.current . | 0.4.0 |
items.buybox.rate | object | Object containing information about the rate of visible ASINs within the portfolio, having a buybox | 0.4.0 |
items.buybox.rate.current | float | Rate of visible ASIns within the portfolio, having a buybox | 0.4.0 |
items.buybox.rate.history | array | Array containing the last 10 items of items.buybox.rate.current . | 0.4.0 |
items.buybox.merchants | object | Object containing information about the number of different merchants owning the buybox for visible ASINs within the portfolio | 0.4.0 |
items.buybox.merchants.current | integer | Number of different merchants owning the buybox for visible ASINs within the portfolio | 0.4.0 |
items.buybox.merchants.history | array | Array containing the last 10 items of items.buybox.merchants.current . | 0.4.0 |
items.subscriptions | object | Object containing information about the visible ASINs within the portfolio being offered as "subscribe & save" | 0.4.0 |
items.subscriptions.total | object | Object containing information about the number of visible ASINs within the portfolio being offered as "subscribe & save" | 0.4.0 |
items.subscriptions.total.current | integer | Number of visible ASINs within the portfolio being offered as "subscribe & save" | 0.4.0 |
items.subscriptions.total.history | array | Array containing the last 10 items of items.subscriptions.total.current . | 0.4.0 |
items.subscritions.rate | object | Object containing information about the rate of visible ASINs within the portfolio being offered as "subscribe & save" | 0.4.0 |
items.subscriptions.rate.current | float | Rate of visible ASINs within the portfolio being offered as "subscribe & save" | 0.4.0 |
items.subscriptions.rate.history | array | Array containing the last 10 items of items.subscriptions.rate.current . | 0.4.0 |
items.types | object | Object containing information about the types of visible ASINs within the portfolio | 0.4.0 |
items.types.standalones | object | Object containing information about the visible ASINs (standalones, non-variations) within the portfolio | 0.4.0 |
items.types.standalones.total | object | Object containing information about the number of visible ASINs (standalones, non-variations) within the portfolio | 0.4.0 |
items.types.standalones.total.current | integer | Number of visible ASINs (standalones, non-variations) within the portfolio | 0.4.0 |
items.types.standalones.total.history | array | Array containing the last 10 items of items.types.standalones.total.current . | 0.4.0 |
items.types.standalones.rate | object | Object containing information about the rate of visible ASINs (standalones non-variations) within the portfolio | 0.4.0 |
items.types.standalones.rate.current | float | Rate of standalones (non-variations) visible ASINs within the portfolio | 0.4.0 |
items.types.standalones.rate.history | array | Array containing the last 10 items of items.types.standalones.rate.current . | 0.4.0 |
items.types.variations | object | Object containing information about the visible ASINs (variations) within the portfolio | 0.4.0 |
items.types.variations.total | object | Object containing information about the number of visible ASINs (variations) within the portfolio | 0.4.0 |
items.types.variations.total.current | integer | Number of visible ASINs (variations) within the portfolio | 0.4.0 |
items.types.variations.total.history | array | Array containing the last 10 items of items.types.variations.total.current . | 0.4.0 |
items.types.variations.rate | object | Object containing information about the rate of visible ASINs (variations) within the portfolio | 0.4.0 |
items.types.variations.rate.current | integer | Rate of visible ASINs (variations) within the portfolio | 0.4.0 |
items.types.variations.rate.history | array | Array containing the last 10 items of items.types.variations.rate.current . | 0.4.0 |
items.bestsellers | object | Object containing information about the visible ASINs within the portfolio, having a bestseller badge | 0.4.0 |
items.bestsellers.total | object | Object containing information about the number of visible ASINs within the portfolio, having a bestseller badge | 0.4.0 |
items.bestsellers.total.curent | integer | Number of visible ASINs within the portfolio, having a bestseller badge | 0.4.0 |
items.bestsellers.total.history | array | Array containing the last 10 items of items.bestsellers.total.current . | 0.4.0 |
items.bestsellers.rate | object | Object containing information about the rate of visible ASINs within the portfolio, having a bestseller badge | 0.4.0 |
items.bestsellers.rate.current | float | Rate of visible ASINs within the portfolio, having a bestseller badge | 0.4.0 |
items.bestsellers.rate.history | array | Array containing the last 10 items of items.bestsellers.rate.current . | 0.4.0 |
items.rating | object | Object containing information about the rating (stars) of visible ASINs within the portfolio | 0.4.0 |
items.rating.all | object | Object containing information about the rating (stars) of visible ASINs within the portfolio (regardless, if they have at least one review) | 0.4.0 |
items.rating.all.avg | object | Object containing information about the average rating (stars) of visible ASINs within the portfolio (regardless, if they have at least one review) | 0.4.0 |
items.rating.all.avg.current | float | Average rating (stars) of visible ASINs within the portfolio (regardless, if they have at least one review) | 0.4.0 |
items.rating.all.avg.history | array | Array containing the last 10 items of items.rating.all.avg.current . | 0.4.0 |
items.rating.exists | object | Object containing information about the rating (stars) of visible ASINs within the portfolio (having at least one review) | 0.4.0 |
items.rating.exists.avg | object | Object containing information about the average rating (stars) of visible ASINs within the portfolio (having at least one review) | 0.4.0 |
items.rating.exists.avg.current | float | Average rating (stars) of visible ASINs within the portfolio (having at least one review) | 0.4.0 |
items.rating.exists.avg.history | array | Array containing the last 10 items of items.rating.exists.avg.current . | 0.4.0 |
items.reviews | object | Object containing information about the number of reviews of visible ASINs within the portfolio | 0.4.0 |
items.reviews.all | object | Object containing information about the number of reviews of visible ASINs within the portfolio (regardless, if they have at least one review) | 0.4.0 |
items.reviews.all.avg | object | Object containing information about the average number reviews of visible ASINs within the portfolio (regardless, if they have at least one review) | 0.4.0 |
items.reviews.all.avg.current | integer | Average number reviews of visible ASINs within the portfolio (regardless, if they have at least one review) | 0.4.0 |
items.reviews.all.avg.history | array | Array containing the last 10 items of items.reviews.all.avg.current . | 0.4.0 |
items.reviews.exists | object | Object containing information about the number of reviews of visible ASINs within the portfolio (having at least one review) | 0.4.0 |
items.reviews.exists.avg | object | Object containing information about the average number reviews of visible ASINs within the portfolio (having at least one review) | 0.4.0 |
items.reviews.exists.avg.current | integer | Average number reviews of visible ASINs within the portfolio (having at least one review) | 0.4.0 |
items.reviews.exists.avg.history | array | Array containing the last 10 items of items.reviews.exists.avg.current . | 0.4.0 |
items.plus | object | Object containing information about the ASINs within the portfolio (offered as Plus) | 0.4.0 |
items.plus.total | object | Object containing information about the total number of ASINs within the portfolio (offered as Plus) | 0.4.0 |
items.plus.total.current | integer | Total number of ASINs within the portfolio (offered as Plus) | 0.4.0 |
items.plus.total.history | array | Array containing the last 10 items of items.plus.total.current . | 0.4.0 |
items.plus.rate | object | Object containing information about the rate of ASINs within the portfolio (offered as Plus) | 0.4.0 |
items.plus.rate.current | float | Rate of ASINs within the portfolio (offered as Plus) | 0.4.0 |
items.plus.rate.history | array | Array containing the last 10 items of items.plus.rate.current . | 0.4.0 |
items.rankings | object | Object containing information about the rankings of visible ASINs within the portfolio | 0.4.0 |
items.rankings.organic | object | Object containing information about the organic rankings of visible ASINs within the portfolio | 0.4.0 |
items.rankings.organic.position | object | Object containing information about the position of organic rankings of visible ASINs within the portfolio | 0.4.0 |
items.rankings.organic.position.avg | object | Object containing information about the average position of organic rankings of visible ASINs within the portfolio | 0.4.0 |
items.rankings.organic.position.avg.current | flaot | The average position of organic rankings of visible ASINs within the portfolio | 0.4.0 |
items.rankings.organic.position.avg.history | array | Array containing the last 10 items of items.rankings.organic.position.avg.history . | 0.4.0 |
items.rankings.organic.rankings | object | Object containing information about the number of organic rankings of visible ASINs within the portfolio | 0.4.0 |
items.rankings.organic.rankings.avg | object | Object containing information about the average number of organic rankings of visible ASINs within the portfolio | 0.4.0 |
items.rankings.organic.rankings.avg.current | float | The average number of organic rankings of visible ASINs within the portfolio | 0.4.0 |
items.rankings.organic.rankings.avg.history | array | Array containing the last 10 items of items.rankings.organic.rankings.avg.current . | 0.4.0 |
items.rankings.organic.choices | object | Object containing information about the number of choice badges, the visible ASINs within the portfolio have | 0.4.0 |
items.rankings.organic.choices.total | object | Object containing information about the total number of choice badges, the visible ASINs within the portfolio have | 0.4.0 |
items.rankings.organic.choices.total.current | integer | Total number of choice badges, the visible ASINs within the portfolio have | 0.4.0 |
items.rankings.organic.choices.total.history | array | Array containing the last 10 items of items.rankings.organic.choices.total.current . | 0.4.0 |
items.rankings.organic.choices.avg | object | Object containing information about the average number of choice badges, the visible ASINs within the portfolio have | 0.4.0 |
items.rankings.organic.choices.avg.current | float | The average number of choice badges, the visible ASINs within the portfolio have | 0.4.0 |
items.rankings.organic.choices.avg.history | array | Array containing the last 10 items of items.rankings.organic.choices.avg.current . | 0.4.0 |
items.promotions | object | Object containing information about the promotions of the visible ASINs within the portfolio | 0.4.0 |
items.promotions.total | object | Object containing information about the number of promotions of the visible ASINs within the portfolio | 0.4.0 |
items.promotions.total.current | integer | The number of promotions of the visible ASINs within the portfolio | 0.4.0 |
items.promotions.total.history | array | Array containing the last 10 items of items.promotions.total.current . | 0.4.0 |
items.promotions.rate | object | Object containing information about the rate of promotions of the visible ASINs within the portfolio | 0.4.0 |
items.promotions.rate.current | float | The rate of promotions of the visible ASINs within the portfolio | 0.4.0 |
items.promotions.rate.history | array | Array containing the last 10 items of items.promotions.rate.current . | 0.4.0 |
stats | object | Object containing general stats of the visible ASINs within the portfolio | 0.4.0 |
stats.as | object | Object containing information about the AMASCORE of the visible ASINs within the portfolio | 0.4.0 |
stats.as.avg | object | Object containing information about the average AMASCORE of the visible ASINs within the portfolio | 0.4.0 |
stats.as.avg.current | float | The average AMASCORE of the visible ASINs within the portfolio | 0.4.0 |
stats.as.avg.history | array | Array containing the last 10 items of stats.as.avg.current . | 0.4.0 |
timestamps | object | Object containing timestamp of the portfolio | 0.4.0 |
timestamps.create | dateTime | Portfolios creation timestamp | 0.4.0 |
timestamps.update | dateTime | Portfolios last-update timestamp | 0.4.0 |
request | object | The request information object (see Request information for more information) | 0.4.0 |
Updates / Changes
Version | Description |
0.4.0 | created |