AMALYZE Falcon API

portfolios.overview (POST)

Endpoint

Endpoint portfolios.overview returns the current overview for a specific portfolio by it’s id.

Method
POST portfolios.overview
Example call

JSON Payload

PropertyTypeDescriptionFurther informationVersion
marketplacestringString containing the marketplace idvalid marketplaces ids0.4.0
portfoliostringString containing the portfolios id0.4.0
JSON Response

PropertyTypeDescriptionVersion
itemsarrayArray containing the portfolio items0.4.0
items.scorefloatInternal match score0.4.0
items.typestringPortfolios type
  • brand
  • merchant
  • category
  • custom
0.4.0
items.namestringPortfolios name0.4.0
items.marketplaceobjectObject containing the marketplace information0.4.0
items.marketplace.idstringThe marketplace ID for the returned product (see marketplace definitions for more informations.0.4.0
items.marketplace.namestringMarketplace name0.4.0
items.totalobjectObject containing information about the total number of ASINs within the portfolio0.4.0
items.total.currentintegerThe number of total ASINs within the portfolio0.4.0
items.total.historyarrayArray containing the last 10 items of items.total.current0.4.0
items.visiblesobjectObject containing information about the visible ASINs within the portfolio0.4.0
items.visibles.totalobjectObject containing information about the number of visible ASINs within the portfolio0.4.0
items.visibles.total.currentintegerNumber of visible ASINs within the portfolio0.4.0
items.visibles.total.historyarrayArray containing the last 10 items of items.visibles.total.current0.4.0
items.visibles.rateobjectObject containing information about the rate of visible ASINs within the portfolio0.4.0
items.visibles.rate.currentfloatRate of visible ASINs within the portfolio0.4.0
items.visibles.rate.historyarrayArray containing the last 10 items of items.visibles.rate.current0.4.0
items.primeobjectObject containing information about the visible ASINs within the portfolio, available as Prime0.4.0
items.prime.totalobjectObject containing information about the number of visible ASINs within the portfolio, available as Prime0.4.0
items.prime.total.currentintegerNumber of visible ASIns within the portfolio available as Prime0.4.0
items.prime.total.historyarrayArray containing the last 10 items of items.prime.total.current.0.4.0
items.prime.rateobjectObject containing information about the rate of visible ASINs within the portfolio, available as Prime0.4.0
items.prime.rate.currentfloatRate of visible ASIns within the portfolio available as Prime0.4.0
items.prime.rate.historyarrayArray containing the last 10 items of items.prime.rate.current.0.4.0
items.bsrobjectObject containing information about the BSRs of visible ASINs within the portfolio0.4.0
items.bsr.mainobjectObject containing information about the (main category) BSRs of visible ASINs within the portfolio0.4.0
items.bsr.main.rankobject0.4.0
items.bsr.main.rank.avgobjectObject containing information about the average (main category) BSRs of visible ASINs within the portfolio0.4.0
items.bsr.main.rank.avg.currentfloatAverage (main category) BSRs of visible ASINs within the portfolio0.4.0
items.bsr.main.rank.avg.historyarrayArray containing the last 10 items of items.bsr.main.rank.avg.history.0.4.0
items.offersobjectObject containing about the number of offers of visible ASINs within the portfolio0.4.0
items.offers.avgobjectObject containing about the average number of offers of visible ASINs within the portfolio0.4.0
items.offers.avg.currentIntegerNumber of average offers of visible ASINs within the portfolio0.4.0
items.offers.avg.historyarrayArray containing the last 10 items of items.offers.avg.history.0.4.0
items.buyboxobjectObject containing information about visible ASINs within the portfolio, having a buybox0.4.0
items.buybox.totalobjectObject containing information about the number of visible ASINs within the portfolio, having a buybox0.4.0
items.buybox.total.currentintegerNumber of visible ASINs within the portfolio, having a buybox0.4.0
items.buybox.total.historyarrayArray containing the last 10 items of items.buybox.total.history.0.4.0
items.buybox.amountobjectObject containing information about the amount of visible ASINs within the portfolio, having a buybox0.4.0
items.buybox.amount.avgobjectObject containing information about the average amount of visible ASINs within the portfolio, having a buybox0.4.0
items.buybox.amount.avg.currentfloatAverage amount of visible ASINs within the portfolio, having a buybox0.4.0
items.buybox.amount.avg.historyarrayArray containing the last 10 items of items.buybox.amount.avg.current.0.4.0
items.buybox.rateobjectObject containing information about the rate of visible ASINs within the portfolio, having a buybox0.4.0
items.buybox.rate.currentfloatRate of visible ASIns within the portfolio, having a buybox0.4.0
items.buybox.rate.historyarrayArray containing the last 10 items of items.buybox.rate.current.0.4.0
items.buybox.merchantsobjectObject containing information about the number of different merchants owning the buybox for visible ASINs within the portfolio0.4.0
items.buybox.merchants.currentintegerNumber of different merchants owning the buybox for visible ASINs within the portfolio0.4.0
items.buybox.merchants.historyarrayArray containing the last 10 items of items.buybox.merchants.current.0.4.0
items.subscriptionsobjectObject containing information about the visible ASINs within the portfolio being offered as "subscribe & save"0.4.0
items.subscriptions.totalobjectObject containing information about the number of visible ASINs within the portfolio being offered as "subscribe & save"0.4.0
items.subscriptions.total.currentintegerNumber of visible ASINs within the portfolio being offered as "subscribe & save"0.4.0
items.subscriptions.total.historyarrayArray containing the last 10 items of items.subscriptions.total.current.0.4.0
items.subscritions.rateobjectObject containing information about the rate of visible ASINs within the portfolio being offered as "subscribe & save"0.4.0
items.subscriptions.rate.currentfloatRate of visible ASINs within the portfolio being offered as "subscribe & save"0.4.0
items.subscriptions.rate.historyarrayArray containing the last 10 items of items.subscriptions.rate.current.0.4.0
items.typesobjectObject containing information about the types of visible ASINs within the portfolio0.4.0
items.types.standalonesobjectObject containing information about the visible ASINs (standalones, non-variations) within the portfolio0.4.0
items.types.standalones.totalobjectObject containing information about the number of visible ASINs (standalones, non-variations) within the portfolio0.4.0
items.types.standalones.total.currentintegerNumber of visible ASINs (standalones, non-variations) within the portfolio0.4.0
items.types.standalones.total.historyarrayArray containing the last 10 items of items.types.standalones.total.current.0.4.0
items.types.standalones.rateobjectObject containing information about the rate of visible ASINs (standalones non-variations) within the portfolio0.4.0
items.types.standalones.rate.currentfloatRate of standalones (non-variations) visible ASINs within the portfolio0.4.0
items.types.standalones.rate.historyarrayArray containing the last 10 items of items.types.standalones.rate.current.0.4.0
items.types.variationsobjectObject containing information about the visible ASINs (variations) within the portfolio0.4.0
items.types.variations.totalobjectObject containing information about the number of visible ASINs (variations) within the portfolio0.4.0
items.types.variations.total.currentintegerNumber of visible ASINs (variations) within the portfolio0.4.0
items.types.variations.total.historyarrayArray containing the last 10 items of items.types.variations.total.current.0.4.0
items.types.variations.rateobjectObject containing information about the rate of visible ASINs (variations) within the portfolio0.4.0
items.types.variations.rate.currentintegerRate of visible ASINs (variations) within the portfolio0.4.0
items.types.variations.rate.historyarrayArray containing the last 10 items of items.types.variations.rate.current.0.4.0
items.bestsellersobjectObject containing information about the visible ASINs within the portfolio, having a bestseller badge0.4.0
items.bestsellers.totalobjectObject containing information about the number of visible ASINs within the portfolio, having a bestseller badge0.4.0
items.bestsellers.total.curentintegerNumber of visible ASINs within the portfolio, having a bestseller badge0.4.0
items.bestsellers.total.historyarrayArray containing the last 10 items of items.bestsellers.total.current.0.4.0
items.bestsellers.rateobjectObject containing information about the rate of visible ASINs within the portfolio, having a bestseller badge0.4.0
items.bestsellers.rate.currentfloatRate of visible ASINs within the portfolio, having a bestseller badge0.4.0
items.bestsellers.rate.historyarrayArray containing the last 10 items of items.bestsellers.rate.current.0.4.0
items.ratingobjectObject containing information about the rating (stars) of visible ASINs within the portfolio0.4.0
items.rating.allobjectObject 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.avgobjectObject 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.currentfloatAverage rating (stars) of visible ASINs within the portfolio (regardless, if they have at least one review)0.4.0
items.rating.all.avg.historyarrayArray containing the last 10 items of items.rating.all.avg.current.0.4.0
items.rating.existsobjectObject containing information about the rating (stars) of visible ASINs within the portfolio (having at least one review)0.4.0
items.rating.exists.avgobjectObject 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.currentfloatAverage rating (stars) of visible ASINs within the portfolio (having at least one review)0.4.0
items.rating.exists.avg.historyarrayArray containing the last 10 items of items.rating.exists.avg.current.0.4.0
items.reviewsobjectObject containing information about the number of reviews of visible ASINs within the portfolio0.4.0
items.reviews.allobjectObject 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.avgobjectObject 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.currentintegerAverage number reviews of visible ASINs within the portfolio (regardless, if they have at least one review)0.4.0
items.reviews.all.avg.historyarrayArray containing the last 10 items of items.reviews.all.avg.current.0.4.0
items.reviews.existsobjectObject containing information about the number of reviews of visible ASINs within the portfolio (having at least one review)0.4.0
items.reviews.exists.avgobjectObject 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.currentintegerAverage number reviews of visible ASINs within the portfolio (having at least one review)0.4.0
items.reviews.exists.avg.historyarrayArray containing the last 10 items of items.reviews.exists.avg.current.0.4.0
items.plusobjectObject containing information about the ASINs within the portfolio (offered as Plus)0.4.0
items.plus.totalobjectObject containing information about the total number of ASINs within the portfolio (offered as Plus)0.4.0
items.plus.total.currentintegerTotal number of ASINs within the portfolio (offered as Plus)0.4.0
items.plus.total.historyarrayArray containing the last 10 items of items.plus.total.current.0.4.0
items.plus.rateobjectObject containing information about the rate of ASINs within the portfolio (offered as Plus)0.4.0
items.plus.rate.currentfloatRate of ASINs within the portfolio (offered as Plus)0.4.0
items.plus.rate.historyarrayArray containing the last 10 items of items.plus.rate.current.0.4.0
items.rankingsobjectObject containing information about the rankings of visible ASINs within the portfolio0.4.0
items.rankings.organicobjectObject containing information about the organic rankings of visible ASINs within the portfolio0.4.0
items.rankings.organic.positionobjectObject containing information about the position of organic rankings of visible ASINs within the portfolio0.4.0
items.rankings.organic.position.avgobjectObject containing information about the average position of organic rankings of visible ASINs within the portfolio0.4.0
items.rankings.organic.position.avg.currentflaotThe average position of organic rankings of visible ASINs within the portfolio0.4.0
items.rankings.organic.position.avg.historyarrayArray containing the last 10 items of items.rankings.organic.position.avg.history.0.4.0
items.rankings.organic.rankingsobjectObject containing information about the number of organic rankings of visible ASINs within the portfolio0.4.0
items.rankings.organic.rankings.avgobjectObject containing information about the average number of organic rankings of visible ASINs within the portfolio0.4.0
items.rankings.organic.rankings.avg.currentfloatThe average number of organic rankings of visible ASINs within the portfolio0.4.0
items.rankings.organic.rankings.avg.historyarrayArray containing the last 10 items of items.rankings.organic.rankings.avg.current.0.4.0
items.rankings.organic.choicesobjectObject containing information about the number of choice badges, the visible ASINs within the portfolio have0.4.0
items.rankings.organic.choices.totalobjectObject containing information about the total number of choice badges, the visible ASINs within the portfolio have0.4.0
items.rankings.organic.choices.total.currentintegerTotal number of choice badges, the visible ASINs within the portfolio have0.4.0
items.rankings.organic.choices.total.historyarrayArray containing the last 10 items of items.rankings.organic.choices.total.current.0.4.0
items.rankings.organic.choices.avgobjectObject containing information about the average number of choice badges, the visible ASINs within the portfolio have0.4.0
items.rankings.organic.choices.avg.currentfloatThe average number of choice badges, the visible ASINs within the portfolio have0.4.0
items.rankings.organic.choices.avg.historyarrayArray containing the last 10 items of items.rankings.organic.choices.avg.current.0.4.0
items.promotionsobjectObject containing information about the promotions of the visible ASINs within the portfolio0.4.0
items.promotions.totalobjectObject containing information about the number of promotions of the visible ASINs within the portfolio0.4.0
items.promotions.total.currentintegerThe number of promotions of the visible ASINs within the portfolio0.4.0
items.promotions.total.historyarrayArray containing the last 10 items of items.promotions.total.current.0.4.0
items.promotions.rateobjectObject containing information about the rate of promotions of the visible ASINs within the portfolio0.4.0
items.promotions.rate.currentfloatThe rate of promotions of the visible ASINs within the portfolio0.4.0
items.promotions.rate.historyarrayArray containing the last 10 items of items.promotions.rate.current.0.4.0
statsobjectObject containing general stats of the visible ASINs within the portfolio0.4.0
stats.asobjectObject containing information about the AMASCORE of the visible ASINs within the portfolio0.4.0
stats.as.avgobjectObject containing information about the average AMASCORE of the visible ASINs within the portfolio0.4.0
stats.as.avg.currentfloatThe average AMASCORE of the visible ASINs within the portfolio0.4.0
stats.as.avg.historyarrayArray containing the last 10 items of stats.as.avg.current.0.4.0
timestampsobjectObject containing timestamp of the portfolio0.4.0
timestamps.createdateTimePortfolios creation timestamp0.4.0
timestamps.updatedateTimePortfolios last-update timestamp0.4.0
requestobjectThe request information object (see Request information for more information)0.4.0
Updates / Changes
VersionDescription
0.4.0created
Menü