Skip to main content
GET
Get Location Status Report

Headers

Accept
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

OK

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.