Reviews and Rating By Location

Reviews & Rating By Location Report

curl --request POST \
  --url https://api.birdeye.com/resources/v1/reports/rating/location \
  --header 'Content-Type: application/json' \
  --data '
{
  "sourceAliases": [
    "citysearch ",
    "google"
  ],
  "businessNumbers": [
    "943967608",
    "943476803"
  ],
  "months": 12
}
'

import requests

url = "https://api.birdeye.com/resources/v1/reports/rating/location"

payload = {
    "sourceAliases": ["citysearch ", "google"],
    "businessNumbers": ["943967608", "943476803"],
    "months": 12
}
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({
    sourceAliases: ['citysearch ', 'google'],
    businessNumbers: ['943967608', '943476803'],
    months: 12
  })
};

fetch('https://api.birdeye.com/resources/v1/reports/rating/location', 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/reports/rating/location",
  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([
    'sourceAliases' => [
        'citysearch ',
        'google'
    ],
    'businessNumbers' => [
        '943967608',
        '943476803'
    ],
    'months' => 12
  ]),
  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/reports/rating/location"

	payload := strings.NewReader("{\n  \"sourceAliases\": [\n    \"citysearch \",\n    \"google\"\n  ],\n  \"businessNumbers\": [\n    \"943967608\",\n    \"943476803\"\n  ],\n  \"months\": 12\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/reports/rating/location")
  .header("Content-Type", "application/json")
  .body("{\n  \"sourceAliases\": [\n    \"citysearch \",\n    \"google\"\n  ],\n  \"businessNumbers\": [\n    \"943967608\",\n    \"943476803\"\n  ],\n  \"months\": 12\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.birdeye.com/resources/v1/reports/rating/location")

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  \"sourceAliases\": [\n    \"citysearch \",\n    \"google\"\n  ],\n  \"businessNumbers\": [\n    \"943967608\",\n    \"943476803\"\n  ],\n  \"months\": 12\n}"

response = http.request(request)
puts response.read_body

[
  {
    "rating": 4.6,
    "count": 132,
    "milestone": "Smile dental",
    "businessId": 943967608,
    "state": "CA"
  },
  {
    "rating": 3.2,
    "count": 367,
    "milestone": "Blaze Dental",
    "businessId": 943589678,
    "state": "CA"
  }
]

{
  "code": 1161,
  "message": "Invalid API key"
}

{
  "code": 1011,
  "message": "Business id is invalid"
}

{
  "code": 89,
  "message": "Rate limit exceeded"
}

POST

reports

rating

location

Reviews & Rating By Location Report

curl --request POST \
  --url https://api.birdeye.com/resources/v1/reports/rating/location \
  --header 'Content-Type: application/json' \
  --data '
{
  "sourceAliases": [
    "citysearch ",
    "google"
  ],
  "businessNumbers": [
    "943967608",
    "943476803"
  ],
  "months": 12
}
'

import requests

url = "https://api.birdeye.com/resources/v1/reports/rating/location"

payload = {
    "sourceAliases": ["citysearch ", "google"],
    "businessNumbers": ["943967608", "943476803"],
    "months": 12
}
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({
    sourceAliases: ['citysearch ', 'google'],
    businessNumbers: ['943967608', '943476803'],
    months: 12
  })
};

fetch('https://api.birdeye.com/resources/v1/reports/rating/location', 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/reports/rating/location",
  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([
    'sourceAliases' => [
        'citysearch ',
        'google'
    ],
    'businessNumbers' => [
        '943967608',
        '943476803'
    ],
    'months' => 12
  ]),
  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/reports/rating/location"

	payload := strings.NewReader("{\n  \"sourceAliases\": [\n    \"citysearch \",\n    \"google\"\n  ],\n  \"businessNumbers\": [\n    \"943967608\",\n    \"943476803\"\n  ],\n  \"months\": 12\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/reports/rating/location")
  .header("Content-Type", "application/json")
  .body("{\n  \"sourceAliases\": [\n    \"citysearch \",\n    \"google\"\n  ],\n  \"businessNumbers\": [\n    \"943967608\",\n    \"943476803\"\n  ],\n  \"months\": 12\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.birdeye.com/resources/v1/reports/rating/location")

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  \"sourceAliases\": [\n    \"citysearch \",\n    \"google\"\n  ],\n  \"businessNumbers\": [\n    \"943967608\",\n    \"943476803\"\n  ],\n  \"months\": 12\n}"

response = http.request(request)
puts response.read_body

[
  {
    "rating": 4.6,
    "count": 132,
    "milestone": "Smile dental",
    "businessId": 943967608,
    "state": "CA"
  },
  {
    "rating": 3.2,
    "count": 367,
    "milestone": "Blaze Dental",
    "businessId": 943589678,
    "state": "CA"
  }
]

{
  "code": 1161,
  "message": "Invalid API key"
}

{
  "code": 1011,
  "message": "Business id is invalid"
}

{
  "code": 89,
  "message": "Rate limit exceeded"
}

Headers

string

e.g. application/json

x-api-key

string

e.g. [Required] Partner specific API key provided by Birdeye for data exchange.

Query Parameters

businessId

number

required

Id of the Business.

sortby

string

Values can be 'count' or 'rating'.

sorder

number

'0' for ascending and '1' for descending order.

Body

application/json

sourceAliases

any[]

List of source aliases.

businessNumbers

any[]

List of business number.

months

number

Use to get results for last some months.

Response

rating

number

Average Rating for the particular location.

count

number

Number of reviews for the particular location.

milestone

string

Name of the Location.

businessId

number

Business number of the location.

state

string

State.

Overview

Business

Custom Fields

User

Reviews

Contact

Contact V2

Campaign

Aggregation

Report

Survey

Business Media

Social

Employee

Conversation

Subscription

Webhook

Competitor

Competitor AI

Insight AI

Google Q&A

Google Services

FAQ

Listing

GMB Products

Search AI

Ticketing

Integration

Reviews and Rating By Location

Headers

Query Parameters

Body

Response