Get Competitor Reviews
curl --request POST \
--url https://api.birdeye.com/resources/v1/review/businessId/{CompetitorEnterpriseBusinessId} \
--header 'Content-Type: application/json' \
--data '
{
"fromDate": "04/01/2013",
"toDate": "05/3/2015",
"updateFromDate": "04/01/2013",
"updateToDate": "05/3/2015",
"sources": [
"google",
"citysearch"
],
"ratings": [
1,
2,
3,
4,
5,
0
],
"searchStr": "test string",
"subBusinessIds": [
145308764185002,
145308769721320,
145308702026610
],
"statuses": [
"published",
"parked"
]
}
'import requests
url = "https://api.birdeye.com/resources/v1/review/businessId/{CompetitorEnterpriseBusinessId}"
payload = {
"fromDate": "04/01/2013",
"toDate": "05/3/2015",
"updateFromDate": "04/01/2013",
"updateToDate": "05/3/2015",
"sources": ["google", "citysearch"],
"ratings": [1, 2, 3, 4, 5, 0],
"searchStr": "test string",
"subBusinessIds": [145308764185002, 145308769721320, 145308702026610],
"statuses": ["published", "parked"]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
fromDate: '04/01/2013',
toDate: '05/3/2015',
updateFromDate: '04/01/2013',
updateToDate: '05/3/2015',
sources: ['google', 'citysearch'],
ratings: [1, 2, 3, 4, 5, 0],
searchStr: 'test string',
subBusinessIds: [145308764185002, 145308769721320, 145308702026610],
statuses: ['published', 'parked']
})
};
fetch('https://api.birdeye.com/resources/v1/review/businessId/{CompetitorEnterpriseBusinessId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.birdeye.com/resources/v1/review/businessId/{CompetitorEnterpriseBusinessId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'fromDate' => '04/01/2013',
'toDate' => '05/3/2015',
'updateFromDate' => '04/01/2013',
'updateToDate' => '05/3/2015',
'sources' => [
'google',
'citysearch'
],
'ratings' => [
1,
2,
3,
4,
5,
0
],
'searchStr' => 'test string',
'subBusinessIds' => [
145308764185002,
145308769721320,
145308702026610
],
'statuses' => [
'published',
'parked'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.birdeye.com/resources/v1/review/businessId/{CompetitorEnterpriseBusinessId}"
payload := strings.NewReader("{\n \"fromDate\": \"04/01/2013\",\n \"toDate\": \"05/3/2015\",\n \"updateFromDate\": \"04/01/2013\",\n \"updateToDate\": \"05/3/2015\",\n \"sources\": [\n \"google\",\n \"citysearch\"\n ],\n \"ratings\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 0\n ],\n \"searchStr\": \"test string\",\n \"subBusinessIds\": [\n 145308764185002,\n 145308769721320,\n 145308702026610\n ],\n \"statuses\": [\n \"published\",\n \"parked\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.birdeye.com/resources/v1/review/businessId/{CompetitorEnterpriseBusinessId}")
.header("Content-Type", "application/json")
.body("{\n \"fromDate\": \"04/01/2013\",\n \"toDate\": \"05/3/2015\",\n \"updateFromDate\": \"04/01/2013\",\n \"updateToDate\": \"05/3/2015\",\n \"sources\": [\n \"google\",\n \"citysearch\"\n ],\n \"ratings\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 0\n ],\n \"searchStr\": \"test string\",\n \"subBusinessIds\": [\n 145308764185002,\n 145308769721320,\n 145308702026610\n ],\n \"statuses\": [\n \"published\",\n \"parked\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.birdeye.com/resources/v1/review/businessId/{CompetitorEnterpriseBusinessId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"fromDate\": \"04/01/2013\",\n \"toDate\": \"05/3/2015\",\n \"updateFromDate\": \"04/01/2013\",\n \"updateToDate\": \"05/3/2015\",\n \"sources\": [\n \"google\",\n \"citysearch\"\n ],\n \"ratings\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 0\n ],\n \"searchStr\": \"test string\",\n \"subBusinessIds\": [\n 145308764185002,\n 145308769721320,\n 145308702026610\n ],\n \"statuses\": [\n \"published\",\n \"parked\"\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"reviewId": "3947127516862",
"rating": 4,
"comments": "Our water polo team stayed there for 4 nights while in for a tournament. It fit our needs perfectly. The rooms were squeaky clean and comfortable. The housekeeping staff was super efficient and k...",
"title": null,
"reviewer": {
"firstName": null,
"lastName": null,
"nickName": "Jen C.",
"thumbnailUrl": "http://d3cnqzq0ivprch.cloudfront.net/demo/css/images/default-profile.png",
"emailId": null,
"facebookId": null,
"city": "Ann Arbor",
"state": "MI"
},
"reviewUrl": "http://www.citysearch.com/not_recommended_reviews/Knzq0i-RsFqWRaNKNWOQbw",
"sourceType": "citysearch",
"reviewDate": "Aug 01, 2014",
"response": null,
"responseDate": null,
"featured": 1,
"businessId": "755009344",
"uniqueReviewUrl": "https://birdeye.com/websiter-755009344/review/3947127516862",
"businessName": "Websiter",
"businessType": "Location"
},
{
"reviewId": "3947077656849",
"rating": 4,
"comments": "Was scared when I saw that is was more if a motel the hotel, but for one night we would give it a try. The rooms were clean and the desk help was also good. It was a little noise but I fell aslee...",
"title": null,
"reviewer": {
"firstName": null,
"lastName": null,
"nickName": "Stella S.",
"thumbnailUrl": "http://d2xt3xymj142xp.cloudfront.net/reviewer/4b7339a2c966485ab58ceaf7ae49e91e.jpeg",
"emailId": null,
"facebookId": null,
"city": "Diamond Bar",
"state": "CA"
},
"reviewUrl": "http://www.citysearch.com/biz/holiday-inn-express-san-jose-central-city-san-jose?hrid=mJpfRj7QaZzxaaLFRfR48w&nb=1",
"sourceType": "citysearch",
"reviewDate": "Jul 31, 2014",
"response": null,
"responseDate": null,
"featured": 0,
"businessId": "755009344",
"uniqueReviewUrl": "https://birdeye.com/websiter-755009344/review/3942327516353",
"businessName": "Websiter",
"businessType": "Location"
}
]{
"code": 1228,
"message": "Invalid updated to date. Allowed format is MM/dd/yyyy"
}{
"code": 1164,
"message": "Invalid result count value"
}{
"code": 1011,
"message": "Business id is invalid"
}{
"code": 89,
"message": "Rate limit exceeded"
}Competitor
Get Competitor Reviews
POST
/
v1
/
review
/
businessId
/
{CompetitorEnterpriseBusinessId}
Get Competitor Reviews
curl --request POST \
--url https://api.birdeye.com/resources/v1/review/businessId/{CompetitorEnterpriseBusinessId} \
--header 'Content-Type: application/json' \
--data '
{
"fromDate": "04/01/2013",
"toDate": "05/3/2015",
"updateFromDate": "04/01/2013",
"updateToDate": "05/3/2015",
"sources": [
"google",
"citysearch"
],
"ratings": [
1,
2,
3,
4,
5,
0
],
"searchStr": "test string",
"subBusinessIds": [
145308764185002,
145308769721320,
145308702026610
],
"statuses": [
"published",
"parked"
]
}
'import requests
url = "https://api.birdeye.com/resources/v1/review/businessId/{CompetitorEnterpriseBusinessId}"
payload = {
"fromDate": "04/01/2013",
"toDate": "05/3/2015",
"updateFromDate": "04/01/2013",
"updateToDate": "05/3/2015",
"sources": ["google", "citysearch"],
"ratings": [1, 2, 3, 4, 5, 0],
"searchStr": "test string",
"subBusinessIds": [145308764185002, 145308769721320, 145308702026610],
"statuses": ["published", "parked"]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
fromDate: '04/01/2013',
toDate: '05/3/2015',
updateFromDate: '04/01/2013',
updateToDate: '05/3/2015',
sources: ['google', 'citysearch'],
ratings: [1, 2, 3, 4, 5, 0],
searchStr: 'test string',
subBusinessIds: [145308764185002, 145308769721320, 145308702026610],
statuses: ['published', 'parked']
})
};
fetch('https://api.birdeye.com/resources/v1/review/businessId/{CompetitorEnterpriseBusinessId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.birdeye.com/resources/v1/review/businessId/{CompetitorEnterpriseBusinessId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'fromDate' => '04/01/2013',
'toDate' => '05/3/2015',
'updateFromDate' => '04/01/2013',
'updateToDate' => '05/3/2015',
'sources' => [
'google',
'citysearch'
],
'ratings' => [
1,
2,
3,
4,
5,
0
],
'searchStr' => 'test string',
'subBusinessIds' => [
145308764185002,
145308769721320,
145308702026610
],
'statuses' => [
'published',
'parked'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.birdeye.com/resources/v1/review/businessId/{CompetitorEnterpriseBusinessId}"
payload := strings.NewReader("{\n \"fromDate\": \"04/01/2013\",\n \"toDate\": \"05/3/2015\",\n \"updateFromDate\": \"04/01/2013\",\n \"updateToDate\": \"05/3/2015\",\n \"sources\": [\n \"google\",\n \"citysearch\"\n ],\n \"ratings\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 0\n ],\n \"searchStr\": \"test string\",\n \"subBusinessIds\": [\n 145308764185002,\n 145308769721320,\n 145308702026610\n ],\n \"statuses\": [\n \"published\",\n \"parked\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.birdeye.com/resources/v1/review/businessId/{CompetitorEnterpriseBusinessId}")
.header("Content-Type", "application/json")
.body("{\n \"fromDate\": \"04/01/2013\",\n \"toDate\": \"05/3/2015\",\n \"updateFromDate\": \"04/01/2013\",\n \"updateToDate\": \"05/3/2015\",\n \"sources\": [\n \"google\",\n \"citysearch\"\n ],\n \"ratings\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 0\n ],\n \"searchStr\": \"test string\",\n \"subBusinessIds\": [\n 145308764185002,\n 145308769721320,\n 145308702026610\n ],\n \"statuses\": [\n \"published\",\n \"parked\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.birdeye.com/resources/v1/review/businessId/{CompetitorEnterpriseBusinessId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"fromDate\": \"04/01/2013\",\n \"toDate\": \"05/3/2015\",\n \"updateFromDate\": \"04/01/2013\",\n \"updateToDate\": \"05/3/2015\",\n \"sources\": [\n \"google\",\n \"citysearch\"\n ],\n \"ratings\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 0\n ],\n \"searchStr\": \"test string\",\n \"subBusinessIds\": [\n 145308764185002,\n 145308769721320,\n 145308702026610\n ],\n \"statuses\": [\n \"published\",\n \"parked\"\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"reviewId": "3947127516862",
"rating": 4,
"comments": "Our water polo team stayed there for 4 nights while in for a tournament. It fit our needs perfectly. The rooms were squeaky clean and comfortable. The housekeeping staff was super efficient and k...",
"title": null,
"reviewer": {
"firstName": null,
"lastName": null,
"nickName": "Jen C.",
"thumbnailUrl": "http://d3cnqzq0ivprch.cloudfront.net/demo/css/images/default-profile.png",
"emailId": null,
"facebookId": null,
"city": "Ann Arbor",
"state": "MI"
},
"reviewUrl": "http://www.citysearch.com/not_recommended_reviews/Knzq0i-RsFqWRaNKNWOQbw",
"sourceType": "citysearch",
"reviewDate": "Aug 01, 2014",
"response": null,
"responseDate": null,
"featured": 1,
"businessId": "755009344",
"uniqueReviewUrl": "https://birdeye.com/websiter-755009344/review/3947127516862",
"businessName": "Websiter",
"businessType": "Location"
},
{
"reviewId": "3947077656849",
"rating": 4,
"comments": "Was scared when I saw that is was more if a motel the hotel, but for one night we would give it a try. The rooms were clean and the desk help was also good. It was a little noise but I fell aslee...",
"title": null,
"reviewer": {
"firstName": null,
"lastName": null,
"nickName": "Stella S.",
"thumbnailUrl": "http://d2xt3xymj142xp.cloudfront.net/reviewer/4b7339a2c966485ab58ceaf7ae49e91e.jpeg",
"emailId": null,
"facebookId": null,
"city": "Diamond Bar",
"state": "CA"
},
"reviewUrl": "http://www.citysearch.com/biz/holiday-inn-express-san-jose-central-city-san-jose?hrid=mJpfRj7QaZzxaaLFRfR48w&nb=1",
"sourceType": "citysearch",
"reviewDate": "Jul 31, 2014",
"response": null,
"responseDate": null,
"featured": 0,
"businessId": "755009344",
"uniqueReviewUrl": "https://birdeye.com/websiter-755009344/review/3942327516353",
"businessName": "Websiter",
"businessType": "Location"
}
]{
"code": 1228,
"message": "Invalid updated to date. Allowed format is MM/dd/yyyy"
}{
"code": 1164,
"message": "Invalid result count value"
}{
"code": 1011,
"message": "Business id is invalid"
}{
"code": 89,
"message": "Rate limit exceeded"
}Headers
e.g. application/json
e.g. [Required] Partner specific API key provided by Birdeye for data exchange.
Query Parameters
Start index of the reviews.
Number of reviews to query.
True for Competitor Review.
Body
application/json
Review date (start) in UTC format.
Review date (end) in UTC format.
Review updated date (start) in UTC format.
Review updated date (end) in UTC format.
Aggregation source name Note: use "our_website" to filter reviews posted on Birdeye platform or use "direct_feedback" for direct feedback.
Review rating Possible values 0,1,2,3,4,5.
String that is contained by review.
BusinessIds under enterprise account.
Review status. Valid values are "published","parked","all". Default is "published" only. Status “published” refers to featured reviews, while “parked” refers to non-featured reviews.
Response
OK