Get Location Status Report
curl --request GET \
--url https://api.birdeye.com/resources/v1/listing/status/locationimport requests
url = "https://api.birdeye.com/resources/v1/listing/status/location"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.birdeye.com/resources/v1/listing/status/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/listing/status/location",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.birdeye.com/resources/v1/listing/status/location"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.birdeye.com/resources/v1/listing/status/location")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.birdeye.com/resources/v1/listing/status/location")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"businessName": "<string>",
"activationStatus": "active/demo/inactive",
"lastUpdated": "Mon Jun 10 09:49:30 GMT 2024",
"locationStatus": "Possible Values “Published”,“Scan State” or “Disabled“",
"totalSites": 44,
"syncedCount": 30,
"submittedCount": 13,
"needUpdatesCount": 123,
"optedOutCount": 123,
"notConnectedCount": 1,
"syncedPercentage": "68.18%",
"submittedPercentage": "29.55%",
"needUpdatesPercentage": "0.00%",
"optedOutPercentage": "0.00%",
"notConnectedPercentage": "2.27%",
"publishListings": "Please initiate Publish for this locations listings.",
"errors": [
"<unknown>"
],
"sites": [
"<unknown>"
]
}{
"code": 1043,
"message": "Business should be either SMB or Enterprise sub account"
}{
"code": 1167,
"message": "API key is missing"
}{
"code": 1175,
"message": "No business found with the given id"
}{
"code": 89,
"message": "Rate limit exceeded"
}Listing
Get Location Status Report
GET
/
v1
/
listing
/
status
/
location
Get Location Status Report
curl --request GET \
--url https://api.birdeye.com/resources/v1/listing/status/locationimport requests
url = "https://api.birdeye.com/resources/v1/listing/status/location"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.birdeye.com/resources/v1/listing/status/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/listing/status/location",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.birdeye.com/resources/v1/listing/status/location"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.birdeye.com/resources/v1/listing/status/location")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.birdeye.com/resources/v1/listing/status/location")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"businessName": "<string>",
"activationStatus": "active/demo/inactive",
"lastUpdated": "Mon Jun 10 09:49:30 GMT 2024",
"locationStatus": "Possible Values “Published”,“Scan State” or “Disabled“",
"totalSites": 44,
"syncedCount": 30,
"submittedCount": 13,
"needUpdatesCount": 123,
"optedOutCount": 123,
"notConnectedCount": 1,
"syncedPercentage": "68.18%",
"submittedPercentage": "29.55%",
"needUpdatesPercentage": "0.00%",
"optedOutPercentage": "0.00%",
"notConnectedPercentage": "2.27%",
"publishListings": "Please initiate Publish for this locations listings.",
"errors": [
"<unknown>"
],
"sites": [
"<unknown>"
]
}{
"code": 1043,
"message": "Business should be either SMB or Enterprise sub account"
}{
"code": 1167,
"message": "API key is missing"
}{
"code": 1175,
"message": "No business found with the given id"
}{
"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
Id of the business.
Response
OK
Name of the Business/Location.
Activation Status of Business/Location
Example:
"active/demo/inactive"
Last Updated Date of a Business/Location.
Example:
"Mon Jun 10 09:49:30 GMT 2024"
Return the state of Business/Location.
Example:
"Possible Values “Published”,“Scan State” or “Disabled“"
Total no. of Sites.
Example:
44
Total no. of Synced sites count.
Example:
30
Total no. of Submitted sites Count.
Example:
13
Total no. of Sites where Action is required.
Total no. of Opted out sites count.
Total no. of Not connected sites count.
Example:
1
Total no. of Synced Sites Percentage.
Example:
"68.18%"
Total no. of Submitted Sites Percentage.
Example:
"29.55%"
Total no. of Need Updates Sites Percentage.
Example:
"0.00%"
Total no. of Opted out sites percentage.
Example:
"0.00%"
Total no. of Not Connected Sites Percentage.
Example:
"2.27%"
Message to initiate publish locations listings.
Example:
"Please initiate Publish for this locations listings."
List of Error messages in case of Not Published state if exists.
List of location status.