Skip to main content
POST
Insights Category Report by location 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.

Content-Type
string
default:application/json

Media type of the JSON request body.

Query Parameters

businessId
number
required

Id of the Business.

Body

application/json
startDate
string

Start Date format MM/dd/YYYY.

endDate
string

End Date format MM/dd/YYYY.

reviewSites
any[]

List of Souce Ids.

businessNumbers
any[]

List of business numbers.

Response

OK

alias
string

Alias of the location.

avgScore
number

Average score of the keywords inside the category.

grade
string

Grade of the keywords.

totalCount
number

Total count of keyword present.

metricForLocn
object

Location wise metric data.