Skip to main content
POST
Listings Insights

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.

Content-Type
string
default:application/json

Media type of the JSON request body.

Query Parameters

businessId
number
required

Id of the account.

Body

application/json
viewMode
any[]
required

for mobile or desktop or both (if none is provided then data for both will be displayed) Example “Desktop”, ”Mobile”

businessNumbers
any[]

Location numbers of enterprise locations. If empty all valid enterprise locations will be selected.

startDate
string

Start Date, Format: yyyy-MM-dd.

endDate
string

End Date, Format: yyyy-MM-dd. If startDate and endDate are not provided, then the last 3 months date range will be chosen.

Response

OK

mapViewTotalCount
number

Business impressions on Google Maps on Desktop and mobile devices. Multiple impressions by a unique user within a single day are counted as a single impression on Google.

Example:

2868

searchViewTotalCount
number

Business impressions on Google Search on Desktop and mobile devices. Multiple impressions by a unique user within a single day are counted as a single impression on Google.

Example:

2868

websiteVisitsTotalCount
number

The number of times the business profile website was clicked on Google.

Example:

2868

getDirectionsTotalCount
number

The number of times a direction request was requested to the business location on Google.

callsTotalCount
number

The number of times the business profile call button was clicked on Google.

Example:

2868

usersReachedTotalCount
number

The number of times your business appeared in search results and other services on Facebook.

usersEngagedTotalCount
number

The number of times users have engaged with your business through reactions, comments, shares and more on Facebook.

impressionCountTotalCount
number

The number of users who saw the activity from your page including posts, check-ins, and ads on Bing.

bingWebsiteVisitsTotalCount
number

The number of times the business profile website was clicked on Bing.

Example:

2868

bingDirectionsTotalCount
number

The number of times a direction request was requested to the business location on Bing.

bingCallsTotalCount
number

The number of times the business profile call button was clicked on Bing.

Example:

2868

liveCount
number

Total no of synched sites for a business.

Example:

10

entityCount
number

Total businesses count.

Example:

1