Skip to main content
POST
Listings Insights Datapoints

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.

Path Parameters

reportType
string
required

Report type, Possible values [google_view_search_map, gmb_customer_actions_map, fb_users_reached,fb_users_engaged, bing_impression_count,bing_customer_actions]

Query Parameters

businessId
number
required

Id of the account.

Body

application/json
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 with groupByType as the day.

viewMode
any[]

is data required for mobile or desktop or both (if none is provided then data for both will be displayed)

groupByType
string

Group the data accordingly. The default value will be the week. Possible values are

Response

OK

label
string

The business counts data on a particular date.

wsiteVisitsCount
number

The number of times the business profile website was clicked.

directionsCount
number

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

callsCount
number

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