Get Location Status Report

curl --request GET \
  --url https://api.birdeye.com/resources/v1/listing/status/location

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))

}

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": "FLTLT - Tulip Cremation Tampa",
  "activationStatus": "active",
  "lastUpdated": "Mon Jun 10 09:49:30 GMT 2024",
  "locationStatus": "Published",
  "publishListings": "Please initiate Publish for this locations listings.",
  "errors": [
    "The selected address is invalid or not supported.",
    "The business description needs to be longer than 200 characters.",
    "Please activate your demo location."
  ],
  "totalSites": 44,
  "syncedCount": 30,
  "submittedCount": 13,
  "needUpdatesCount": 0,
  "optedOutCount": 0,
  "notConnectedCount": 1,
  "syncedPercentage": "68.18%",
  "submittedPercentage": "29.55%",
  "needUpdatesPercentage": "0.00%",
  "optedOutPercentage": "0.00%",
  "notConnectedPercentage": "2.27%",
  "sites": [
    {
      "siteId": 2,
      "siteName": "Google Maps",
      "status": "Action Required",
      "errors": [
        "The geographic coordinates and the address you provided do not match. Make sure that the address line and zip code are correct."
      ],
      "url": "https://maps.google.com/maps?cid=17209435735184138870"
    },
    {
      "siteId": 110,
      "siteName": "Facebook",
      "status": "Connect"
    },
    {
      "siteId": 226,
      "siteName": "Bing",
      "status": "In Progress",
      "url": "https://www.bing.com/maps?ss=ypid.YN377x6765823"
    },
    {
      "siteId": 100,
      "siteName": "Birdeye",
      "status": "Synced",
      "url": "https://birdeye.com/farm-bureau-insurance-163944578027442"
    },
    {
      "siteId": 381,
      "siteName": "Apple Maps",
      "status": "Action Required",
      "errors": [
        "Apple Category for the business is not available"
      ]
    },
    {
      "siteId": 142,
      "siteName": "Opendi",
      "status": "Action Required",
      "errors": [
        "We’re unable to update your listing as there is a 'Claim Listing' issue which requires release of management of listings from the previous listings management provider. Please contact support for assistance."
      ],
      "url": "https://columbia-la.opendi.us/10046961.html"
    }
  ]
}

{
  "code": 1043,
  "message": "Business should be either SMB or Enterprise sub account"
}

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

{
  "code": 1175,
  "message": "No business found with the given id"
}

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

GET

listing

status

location

Get Location Status Report

curl --request GET \
  --url https://api.birdeye.com/resources/v1/listing/status/location

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))

}

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": "FLTLT - Tulip Cremation Tampa",
  "activationStatus": "active",
  "lastUpdated": "Mon Jun 10 09:49:30 GMT 2024",
  "locationStatus": "Published",
  "publishListings": "Please initiate Publish for this locations listings.",
  "errors": [
    "The selected address is invalid or not supported.",
    "The business description needs to be longer than 200 characters.",
    "Please activate your demo location."
  ],
  "totalSites": 44,
  "syncedCount": 30,
  "submittedCount": 13,
  "needUpdatesCount": 0,
  "optedOutCount": 0,
  "notConnectedCount": 1,
  "syncedPercentage": "68.18%",
  "submittedPercentage": "29.55%",
  "needUpdatesPercentage": "0.00%",
  "optedOutPercentage": "0.00%",
  "notConnectedPercentage": "2.27%",
  "sites": [
    {
      "siteId": 2,
      "siteName": "Google Maps",
      "status": "Action Required",
      "errors": [
        "The geographic coordinates and the address you provided do not match. Make sure that the address line and zip code are correct."
      ],
      "url": "https://maps.google.com/maps?cid=17209435735184138870"
    },
    {
      "siteId": 110,
      "siteName": "Facebook",
      "status": "Connect"
    },
    {
      "siteId": 226,
      "siteName": "Bing",
      "status": "In Progress",
      "url": "https://www.bing.com/maps?ss=ypid.YN377x6765823"
    },
    {
      "siteId": 100,
      "siteName": "Birdeye",
      "status": "Synced",
      "url": "https://birdeye.com/farm-bureau-insurance-163944578027442"
    },
    {
      "siteId": 381,
      "siteName": "Apple Maps",
      "status": "Action Required",
      "errors": [
        "Apple Category for the business is not available"
      ]
    },
    {
      "siteId": 142,
      "siteName": "Opendi",
      "status": "Action Required",
      "errors": [
        "We’re unable to update your listing as there is a 'Claim Listing' issue which requires release of management of listings from the previous listings management provider. Please contact support for assistance."
      ],
      "url": "https://columbia-la.opendi.us/10046961.html"
    }
  ]
}

{
  "code": 1043,
  "message": "Business should be either SMB or Enterprise sub account"
}

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

{
  "code": 1175,
  "message": "No business found with the given id"
}

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

Headers

string

default:application/json

e.g. application/json

x-api-key

string

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

Query Parameters

businessNumber

number

required

Id of the business.

Response

businessName

string

Name of the Business/Location.

activationStatus

string

Activation Status of Business/Location

Example:

"active/demo/inactive"

lastUpdated

string

Last Updated Date of a Business/Location.

Example:

"Mon Jun 10 09:49:30 GMT 2024"

locationStatus

string

Return the state of Business/Location.

Example:

"Possible Values “Published”,“Scan State” or “Disabled“"

totalSites

number

Total no. of Sites.

Example:

44

syncedCount

number

Total no. of Synced sites count.

Example:

30

submittedCount

number

Total no. of Submitted sites Count.

Example:

13

needUpdatesCount

number

Total no. of Sites where Action is required.

optedOutCount

number

Total no. of Opted out sites count.

notConnectedCount

number

Total no. of Not connected sites count.

Example:

1

syncedPercentage

string

Total no. of Synced Sites Percentage.

Example:

"68.18%"

submittedPercentage

string

Total no. of Submitted Sites Percentage.

Example:

"29.55%"

needUpdatesPercentage

string

Total no. of Need Updates Sites Percentage.

Example:

"0.00%"

optedOutPercentage

string

Total no. of Opted out sites percentage.

Example:

"0.00%"

notConnectedPercentage

string

Total no. of Not Connected Sites Percentage.

Example:

"2.27%"

publishListings

string

Message to initiate publish locations listings.

Example:

"Please initiate Publish for this locations listings."

errors

any[]

List of Error messages in case of Not Published state if exists.

sites

object[]

List of location status.

Show child attributes

Get Started

Reference

Get Location Status Report

Headers

Query Parameters

Response