Competitors API

In this documentation, you can find descriptions of the BrandWizard API methods for the Competitors section.

• Description: List of your competitors with their source networks, locations, and status.
• Request parameters:
  

  Parameter	Type	Required?	Description
  count	integer	No	Number of results for paginated return
  page	integer	No	Page number within the paginated result set

• Response fields:

   

  Field				Type	Description
  count				integer	Number of records
  next				string	Link to the next page
  previous				string	Link to the previous page
  results	id			integer	Competitor ID
  	name			string	Competitor name
  	networks	website		string	Catalog website, e.g. google_maps, 2gis.ru, yandex_maps
  		type		string	Source type: network or organization
  		external_id		string	Network ID in the catalog
  		status		string	Source processing status
  	locations	company_id		integer	Company ID
  		name		string	Location name
  		city		string	City
  		address		string	Address
  		is_closed		boolean	true if the competitor location is closed
  		catalogs	website	string	Catalog website
  			origin_id	string	Location ID in the catalog
  			origin_url	string	Location URL in the catalog
  			catalog_status	string	Location status in the catalog

• Description: Metrics by catalog for your competitors' locations, with optional rating history.
• Request parameters:
  

  Parameter	Type	Required?	Description
  catalog	string	No	Catalog, available options: 2gis.ru, google, yandex. Must select one.
  city_ids	array[integer]	No	City IDs where competitor locations are located (pass an array of city IDs)
  code	string	No	Competitor branch code
  competitor_id	integer	No	Competitor ID
  count	integer	No	Number of results for paginated return
  end_date	string	No	End of the rating history period (together with start_date). Date format
  page	integer	No	Page number within the paginated result set
  start_date	string	No	Start of the rating history period (together with end_date). Date format

• Response fields:

  Field				Type	Description
  count				integer	Number of records (e.g., 123)
  next				string	Link to the next page
  previous				string	Link to the previous page
  results	competitor_id			integer	Competitor ID
  	competitor_name			string	Competitor name
  	company_id			integer	Company ID
  	name			string	Location name
  	city			string	City
  	address			string	Address
  	metrics	website		string	Catalog website
  		reviews_count		integer	Number of reviews
  		ratings_count		integer	Number of ratings (not provided by Google)
  		rating		number	Average rating
  		is_verified		boolean	Blue checkmark / verified owner (for Yandex catalog)
  		has_priority_placement		boolean	Paid placement
  		is_closed		boolean	Location closure status
  		rating_history	date	string	Date (day)
  			rating	number	Rating for that day