AMALYZE Falcon API

research.product.competitors (POST)

Endpoint

Endpoint research.product.competitors returns the competitors for a ASIN / marketplace combination.

Method
POST research.product.competitors
Example call

JSON Payload

PropertyTypeDescriptionFurther informationVersion
paginationobjectObject containing the pagination informationpagination object definition0.1.16
filtersobjectObject containing the filter information0.1.16
filters.marketplacestringString containing the marketplace IDrequired. valid marketplaces ids0.1.16
filters.asinstringString containing the ASIN to received competitors forsrequired0.1.16
filters.upcsarrayArray containing the ASINs to search foroptional / not yet available0.1.16
filters.titlestringThe title to search foroptional0.1.16
filters.brandsarrayArray containing the brands to search for (full text search)optional0.1.16
filters.brandsExactarrayArray containing the brands to search for (exact match)optional0.1.16
filters.merchantsarrayArray containing the merchant names to search for (full textsearch)optional0.1.16
.filters.merchantsExactarrayArray containing the merchant names to search for (exact match)optional0.1.16
filters.merchantsIdarrayArray containing the merchant ids to search foroptional0.1.16
filters.availablebooleanFilters for products that must (not) be availableoptional / currently all products are marked as available0.1.16
filters.categoriesarrayArray containing the category IDs to search foroptional / not yet available0.1.16
filters.primebooleanFilters for products that must (not) be offered as primeoptional0.1.16
filters.advertisingSpabooleanFilters for products that must (not) be advertising as sponsored product adsoptional0.1.16
filters.buyboxbooleanFilters for products that must (not) have a buyboxoptional0.1.16
filters.querystringFulltext search over all available fieldsoptional0.1.16
filters.typesarrayArray containing the product typeoptional (see product type definition for more information)0.1.16
filters.competitorsobjectObject containing information about the competitorsoptional / not yet available0.1.16
filters.competitors.minintegerNumber of minimum competitors the products may haveoptional / not yet available0.1.16
filters.competitors.maxintegerNumber of maximum competitors the products may haveoptional / not yet available0.1.16
filters.bsrobjectObject containing information about the products main category BSRoptional / not yet available0.1.16
filters.bsr.minintegerMinium BSR the products must haveoptional / not yet available0.1.16
filters.bsr.maxintegerMaximum BSR the products must haveoptional / not yet available0.1.16
filters.priceobjectObject containing information about the products priceoptional0.1.16
filters.price.minfloatMinimum price the products must haveoptional0.1.16
filters.price.maxfloatMaximum price the products must haveoptional0.1.16
filters.optimizationobjectObject containing information about the products optimizationoptional / not yet available0.1.16
filters.optimization.minfloatMinimum (percentage) optimization the products must haveoptional / not yet available0.1.16
filters.optimization.maxfloatMaximum (percentage) optimization the products must haveoptional / not yet available0.1.16
filters.ratingobjectObject containing information about the products ratingoptional0.1.16
filters.rating.minfloatMinimum rating (stars) the products must haveoptional0.1.16
filters.rating.maxfloatMaximum rating (stars) the products must haveoptional0.1.16
filters.reviewsobjectObject containing information about the products reviewsoptional0.1.16
filters.reviews.minintegerMinimum reviews the products must haveoptional0.1.16
filters.reviews.maxintegerMaximum reviews the products must haveoptional0.1.16
keywordsOrganicPosobjectObject containing the information about the average position of organic keywordsoptional0.1.16
keywordsOrganicPos.minintegerMinimum average position of organic keywordsoptional0.1.16
keywordsOrganicPos.maxintegerMaximum average position of organic keywordsoptional0.1.16
keywordsOrganicCountobjectObject containing the information about the number of organic keywordsoptional0.1.16
keywordsOrganicCount.minintegerMinimum number of organic keywordsoptional0.1.16
keywordsOrganicCount.maxintegerMaximum number of organic keywordsoptional0.1.16
statsOrganicImpressionsobjectObject containing the information about the searchVolumne for all the keywords the product ranks foroptional0.1.16
statsOrganicImpressions.minintegerMinimum searchVolumeoptional0.1.16
statsOrganicImpressions.maxintegerMaximum searchVolumeoptional0.1.16
sortingarrayArray containing the sorting information0.1.16
sorting.columnstringThe column to sort
  • score: sort by internal matching score
  • amazon.title: sort by products title
  • amazon.reviews.total:sort by number of reviews
  • amazon.reviews.score: sort by average rating
  • amazon.brand.name: sort by brand name
  • amazon.buybox.merchant.name: sort by merchant name owning the buybox
  • amazon.buybox.prices.rrp: sort be recommended retail price
  • amazon.buybox.prices.offer: sort by offer price
  • amalyze.keywords.organic.pos: sort by average position of organic keywords
  • amalyze.keywords.organic.count: sort by number of organic keywords
  • amalyze.stats.organic.impressions: sort by monthy impressions, all the keywords the product ranks for, generate
0.1.16
sorting.directionstringThe direction to sortvalid direction values0.1.16
JSON Response

PropertyTypeDescription
itemsarrayArray containing the product items (for more information see product object definition
paginationobjectThe pagination object (see Pagination for more information)
requestobjectThe request inforamtion object (see Request information for more information)
Updates / Changes
VersionDescription
0.1.16implemented endpoint
Menu