v1 API

Contents:

• Method GET/public/v1/companies/rating/{id}/
• Method GET/public/v1/questions/
• Method GET/public/v1/questions/{id}/
• Method GET/public/v1/questions/statistic/

---

In this documentation, you can find a description of the methods of the BrandWizard API section v1. 

 

 

Method GET/public/v1/companies/rating/{id}/

• Description: Retrieve the rating of a specific company.

• Request parameters:

Parameter	Type	Required?	Description
id	integer	Yes	Company ID

• Response fields: None.

 

---

 

Method GET/public/v1/questions/

• Description: Retrieve a list of questions.

• Request parameters:

Parameter	Type	Required?	Description
brand_ids	array[integer]	No	List of brand IDs
city_ids	array[integer]	No	List of city IDs
company_group_ids	array[integer]	No	List of company group IDs
company_ids	array[integer]	No	List of company IDs
count	integer	No	Number of results for paginated return
date_after	string	No	Creation period from
date_before	string	No	Creation period to
filter_key	string	No	Filter key
has_owner_answer	boolean	No	Has owner's answer: Yes/No
ids	array[integer]	No	List of question IDs
page	integer	No	Page number within the pagination result set
replier_id	string	No	Answer ID

• Response fields:

Field				Type	Description
count				integer	Number of results
next				string	Link to the next page
previous				string	Link to the previous page
results	id			integer	Question ID
	author			string	Author name
	author_type			string	merchant – Location owner user – User
	text			string	Question text
	date_created			string	Creation date
	has_owner_answer			boolean	Has owner's answer: Yes/No
	url			string	Question link
	company	id		integer	Company ID
		name		string	Company name
		code		string	Company code
		address	country	string	Country where the company is located
			country_code	string	Country code
			region	string	Region
			city	string	City
			street	string	Street
			housenumber	string	House number
			postcode	string	Postal code
			description	string	Additional information about company location
			lat	number	Latitude coordinates
			lon	number	Longitude coordinates
		categories	id	integer	Category ID
			name	string	Category name
			is_main	boolean	Main category: Yes/No
	brand		id	integer	Brand ID
			name	string	Brand name
	answers		id	integer	Answer ID
			author	string	Answer author name
			author_type	string	merchant – Location owner user – User
			text	string	Answer text
			date_created	string	Creation date
			user	string	User ID who leaves the answer, if present in the database
	can_reply			boolean	Answer possible: Yes/No

 

---

 

Method GET/public/v1/questions/{id}/

• Description: Retrieve a question by its unique identifier.

• Request parameters:

Parameter	Type	Required?	Description
id	integer	Yes	ID вопроса

• Response fields:

Field			Type	Description
id			integer	Question ID
author			string	Author name
author_type			string	merchant – Location owner user – User
text			string	Question text
date_created			string	Creation date
has_owner_answer			boolean	Has owner's answer: Yes/No
url			string	Question link
company	id		integer	Company ID
	name		string	Company name
	code		string	Company code
	address	country	string	Country where the company is located
		country_code	string	Country code
		region	string	Region
		city	string	City
		street	string	Street
		housenumber	string	House number
		postcode	string	Postal code
		description	string	Additional information about company location
		lat	number	Latitude coordinates
		lon	number	Longitude coordinates
	categories	id	integer	Category ID
		name	string	Category name
		is_main	boolean	Main category: Yes/No
brand		id	integer	Brand ID
		name	string	Brand name
answers		id	integer	Answer ID
		author	string	Answer author name
		author_type	string	merchant – Location owner user – User
		text	string	Answer text
		date_created	string	Creation date
		user	string	User ID who leaves the answer, if present in the database
can_reply			boolean	Answer possible: Yes/No

 

---

 

Method GET/public/v1/questions/statistic/

• Description: Retrieve statistics on questions.

• Request parameters: None.

• Response fields:

  Field	Type	Description
  all	integer	Total number of questions
  has_answers	integer	Number of questions with an answer
  has_no_answers	integer	Number of questions without an answer