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

curl https://falcon.amalyze.com/<VERSION>/research.products.search \
-X POST \
-H "X-Falcon-Token: <YOUR-TOKEN-HERE>" \
-d '
{
	"filters":{
		"marketplace":"A1PA6795UKMFR9",
		"asin":"B00HADE3WQ"
	},
	"pagination":{
		"page":1,
		"size":10
	},"sorting":[
		{
			"direction":"desc",
			"column":"amalyze.stats.organic.impressions"
		}
	]
}

'

curl https://falcon.amalyze.com/<VERSION>/research.products.search \

-X POST \

-H "X-Falcon-Token: <YOUR-TOKEN-HERE>" \

-d '

{

"filters":{

"marketplace":"A1PA6795UKMFR9",

"asin":"B00HADE3WQ"

"pagination":{

"page":1,

"size":10

},"sorting":[

{

"direction":"desc",

"column":"amalyze.stats.organic.impressions"

}

]

}

JSON Payload

{
	"filters":{
		"marketplace":"A1PA6795UKMFR9",
		"asin":"B00HADE3WQ"
	},
	"pagination":{
		"page":1,
		"size":10
	},"sorting":[
		{
			"direction":"desc",
			"column":"amalyze.stats.organic.impressions"
		}
	]
}

{

"filters":{

"marketplace":"A1PA6795UKMFR9",

"asin":"B00HADE3WQ"

"pagination":{

"page":1,

"size":10

},"sorting":[

{

"direction":"desc",

"column":"amalyze.stats.organic.impressions"

}

]

}

Property	Type	Description	Further information	Version
`pagination`	object	Object containing the pagination information	pagination object definition	0.1.16
`filters`	object	Object containing the filter information		0.1.16
`filters.marketplace`	string	String containing the marketplace ID	required. valid marketplaces ids	0.1.16
`filters.asin`	string	String containing the ASIN to received competitors fors	required	0.1.16
`filters.upcs`	array	Array containing the ASINs to search for	optional / not yet available	0.1.16
`filters.title`	string	The title to search for	optional	0.1.16
`filters.brands`	array	Array containing the brands to search for (full text search)	optional	0.1.16
`filters.brandsExact`	array	Array containing the brands to search for (exact match)	optional	0.1.16
`filters.merchants`	array	Array containing the merchant names to search for (full textsearch)	optional	0.1.16
`.filters.merchantsExact`	array	Array containing the merchant names to search for (exact match)	optional	0.1.16
`filters.merchantsId`	array	Array containing the merchant ids to search for	optional	0.1.16
`filters.available`	boolean	Filters for products that must (not) be available	optional / currently all products are marked as available	0.1.16
`filters.categories`	array	Array containing the category IDs to search for	optional / not yet available	0.1.16
`filters.prime`	boolean	Filters for products that must (not) be offered as prime	optional	0.1.16
`filters.advertisingSpa`	boolean	Filters for products that must (not) be advertising as sponsored product ads	optional	0.1.16
`filters.buybox`	boolean	Filters for products that must (not) have a buybox	optional	0.1.16
`filters.query`	string	Fulltext search over all available fields	optional	0.1.16
`filters.types`	array	Array containing the product type	optional (see product type definition for more information)	0.1.16
`filters.competitors`	object	Object containing information about the competitors	optional / not yet available	0.1.16
`filters.competitors.min`	integer	Number of minimum competitors the products may have	optional / not yet available	0.1.16
`filters.competitors.max`	integer	Number of maximum competitors the products may have	optional / not yet available	0.1.16
`filters.bsr`	object	Object containing information about the products main category BSR	optional / not yet available	0.1.16
`filters.bsr.min`	integer	Minium BSR the products must have	optional / not yet available	0.1.16
`filters.bsr.max`	integer	Maximum BSR the products must have	optional / not yet available	0.1.16
`filters.price`	object	Object containing information about the products price	optional	0.1.16
`filters.price.min`	float	Minimum price the products must have	optional	0.1.16
`filters.price.max`	float	Maximum price the products must have	optional	0.1.16
`filters.optimization`	object	Object containing information about the products optimization	optional / not yet available	0.1.16
`filters.optimization.min`	float	Minimum (percentage) optimization the products must have	optional / not yet available	0.1.16
`filters.optimization.max`	float	Maximum (percentage) optimization the products must have	optional / not yet available	0.1.16
`filters.rating`	object	Object containing information about the products rating	optional	0.1.16
`filters.rating.min`	float	Minimum rating (stars) the products must have	optional	0.1.16
`filters.rating.max`	float	Maximum rating (stars) the products must have	optional	0.1.16
`filters.reviews`	object	Object containing information about the products reviews	optional	0.1.16
`filters.reviews.min`	integer	Minimum reviews the products must have	optional	0.1.16
`filters.reviews.max`	integer	Maximum reviews the products must have	optional	0.1.16
`keywordsOrganicPos`	object	Object containing the information about the average position of organic keywords	optional	0.1.16
`keywordsOrganicPos.min`	integer	Minimum average position of organic keywords	optional	0.1.16
`keywordsOrganicPos.max`	integer	Maximum average position of organic keywords	optional	0.1.16
`keywordsOrganicCount`	object	Object containing the information about the number of organic keywords	optional	0.1.16
`keywordsOrganicCount.min`	integer	Minimum number of organic keywords	optional	0.1.16
`keywordsOrganicCount.max`	integer	Maximum number of organic keywords	optional	0.1.16
`statsOrganicImpressions`	object	Object containing the information about the searchVolumne for all the keywords the product ranks for	optional	0.1.16
`statsOrganicImpressions.min`	integer	Minimum searchVolume	optional	0.1.16
`statsOrganicImpressions.max`	integer	Maximum searchVolume	optional	0.1.16
`sorting`	array	Array containing the sorting information		0.1.16
`sorting.column`	string	The 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.direction`	string	The direction to sort	valid direction values	0.1.16

JSON Response

{
    "items": [
        {<product>}
    ],
    "pagination": {
        {"filtered": 123}
    },
    "request": {
        "id": "708f6b29-0c41-4cd1-ba9a-4346a66fedf9",
        "took": 0.0571,
        "costs": 1,
        "remaining": 99999,
        "method": "research.product.general.get",
        "success": true,
        "error": {
            "code": null,
            "message": null,
            "hint": null
        }
    }
}

{

"items": [

{<product>}

"pagination": {

{"filtered": 123}

"request": {

"id": "708f6b29-0c41-4cd1-ba9a-4346a66fedf9",

"took": 0.0571,

"costs": 1,

"remaining": 99999,

"method": "research.product.general.get",

"success": true,

"error": {

"code": null,

"message": null,

"hint": null

}

Property	Type	Description
`items`	array	Array containing the product items (for more information see product object definition
`pagination`	object	The pagination object (see Pagination for more information)
`request`	object	The request inforamtion object (see Request information for more information)