AMALYZE Falcon API

Keyword Object

Definition

PropertyTypeDescriptionCommentVersion
scorefloatInternal score for matching0.1.10
keywordobjectObject containing the keyword information0.1.10
keyword.keywordstringThe requested keyword0.1.10
keyword.idstringInternal keyword ID0.1.10
marketplaceobjectObject containing the marktplace information0.1.10
marketplace.idstringThe official marketplace ID(valid marketplace ids)0.1.10
marketplace.namestringThe marketplace’s name0.1.10
brandsarrayArray containing the brands (as string)0.1.10
buyboxobjectObject containing the buybox information0.1.10
buybox.merchantsintegerNumber of (different) unique merchants, holding the buybox0.1.10
buybox.ratefloatRate of products under this keyword, having a buybox0.1.10
buybox.offerobjectObject containing the pricing information0.1.10
buybox.offer.avgfloatAverage price (offers) for products ranking for this keyword0.1.12
buybox.offer.minfloatMinimum price (offers) for products ranking for this keyword0.1.10
buybox.offer.maxfloatMaximum price (offers) for products ranking for this keyword0.1.10
buybox.offer.currenystringCurrency0.1.10
buybox.rrpobjectObject containing the recommend retail price (rrp) information0.1.12
buybox.rrp.avgfloatAverage recommended retail price (rrp) for products ranking for this keyword0.1.12
buybox.rrp.minfloatMinimum recommended retail price (rrp) for products ranking for this keyword0.1.12
buybox.rrp.maxfloatMaximum recommended retail price (rrp) for products ranking for this keyword0.1.12
buybox.rrp.currenystringCurrency0.1.2
buybox.strokeobjectObject containing the stroke price information0.1.10
buybox.stroke.ratefloatrate of products under this keywords, having a stroke price0.1.10
resultsobjectobject containing information about the search results for this keyword0.1.10
results.organicobjectobject containing information about the organic search results for this keyword0.1.10
results.organic.countintegernumber of products ranking (organically) for this keyword0.1.10
results.advertisingobjectobject containing information about the advertised products for this keyword0.1.10
results.advertising.spaobjectobject containing information about the advertised (sponsored product ads) for this keyword0.1.10
results.advertising.spa.countintegernumber of products delivered by sponsored product ads for this keyword0.1.10
results.advertising.hsabooleanindicates, if there are headline search ads (HSA) for this keyword0.1.10
categoriesobjectobject containing information about the relevant categories for this keyword0.1.10
categories.totalintegernumber of different relevant categories for this keyword0.1.10
categories.rootobjectobject containing information about the main category for this keyword0.1.10
categories.root.idstringthe amazon browse-node id for the main category0.1.10
categories.root.namestringthe (translated to the marketplace-language) name of the browse node for the main category0.1.10
categories.categoriesarrayarray containing further relevant categories for this keyword0.1.10
categories.categories.idstringthe amazon browse-node id for this category0.1.10
categories.categories.namestringthe (translated to the marketplace-language) name of the browse node for this category0.1.12
categories.categories.categoriesarrayarray containing further relevant subcategories for this keyword0.1.12
categories.categories.categories.idstringthe amazon browse-node id for this subcategory0.1.12
categories.categories.categories.namestringthe (translated to the marketplace-language) name of the browse node for this subcategory0.1.12
correctionobjectobject containing the correction information0.1.10
correction.correctionstringcorrection of the entered keyword (if applicable)0.1.10
correction.typestringtype of correction (if applicable)
  • correctedsearchterm is corrected and redirected
  • suggestcorrection is suggested but not redirected
  • noneno correction found
0.1.10
relatedobjectobject containing related keywords0.1.10
related.existsbooleanindicates if related keywords exist0.1.10
related.keywordsarrayrelated keywords (string)0.1.10
successbooleanindicates if the requested keyword is known by AMALYZE0.1.10
errorobjectobject containing the error information (if occured)0.1.10
filtersarrayarray containing the filter information for the requested keyword0.1.10
filters.valuesarrayarray containing the filter values for the requested keyword0.1.10
filters.values.namestringthe name of the filter values0.1.10
filters.namestringthe filter’s name0.1.10
reviewsobjectobject containing the reviews information0.1.10
reviews.avgfloataverage number of reviews for the products ranking for the keyword0.1.12
reviews.minfloatminimum number of reviews for the products ranking for the keyword (products with no reviews are ignored)0.1.12
reviews.maxfloatmaximum number of reviews for the products ranking for the keyword0.1.12
ratingobjectobject containing the rating information
rating.avgfloataverage rating (stars) for products ranking for the keyword0.1.12
rating.minfloatminimum rating (stars) for products ranking for the keyword0.1.12
rating.maxfloatmaximum rating (stars) for products ranking for the keyword0.1.12
optimizationobjectobject containing the optimization informationnot yet implemented
optimization.totalfloataverage optimization value for products ranking for the keyordnot yet implemented
statsobjectobject containing the staticti object for the keyword0.1.15
stats.impressionsintegerinteger containing the monthly searchVolume for the keyword0.1.15
stats.salesobjectobject containing the sales info for the keyword0.1.15
stats.sales.amountfloatestimated monthly sales for this keyword0.1.15
stats.sales.currencystringCurrency0.1.15
updateobjectobject containing the update information0.1.10
update.lastdateTimetimestamp when keyword was last updated0.1.10
Update changes
VersionDescription
0.1.15added stats.impressions
added stats.sales
removed buybox.offer.amount
removed results.advertising.spa.ration
removed categories.categies.text
removed reviews.total
removed rating.score
0.1.12added buybox.offer.avg
marked buybox.offer.amount as deprecated
added buybox.rrp
added buybox.rrp.avg
added buybox.rrp.min
added buybox.rrp.max
added buybox.rrp.currency
marked results.advertising.spa.ratio
marked categories.categories.text
added categories.categories.name
added categories.categories.categories
added categories.categories.categories.id
added categories.categories.categories.name
marked reviews.total as deprecated
added reviews.avg
added reviews.min
added reviews.max
marked rating.score as deprecated
added rating.avg
added rating.min
added rating.max
Menu