Skip to main content
POST
Get Insight Reputation Location Info

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.

x-business-number
string

e.g. [Required] User associated businessNumber.

Content-Type
string
default:application/json

Media type of the JSON request body.

Query Parameters

start-index
integer
default:0

Zero-based index of the first record to return.

page-size
integer
default:10

Number of records to return. Must be between 1 and 100 (default 10).

sort-by
enum<string>
default:name

Field to sort results by.

Available options:
name,
reputation-score
sort-order
enum<integer>
default:0

Sort order. 0 = ascending, 1 = descending.

Available options:
0,
1

Body

application/json
businessNumbers
integer[]
required

List of business numbers (max 100).

startDate
string
required

Start date in MM/DD/YYYY format.

endDate
string
required

End date in MM/DD/YYYY format.

userEmail
string
required

Email of the user performing the request.

reviewSources
string[]

Review sources to include (e.g. Google, Facebook).

ratings
string[]

Rating values to filter (e.g. "1", "2", "3", "4", "5").

hierarchyNodeData
object[]

List of hierarchy nodes to filter by level.

groupByLevel
string

The level to group results by (e.g. Region).

Response

OK

totalCount
integer
dataPoints
object[]