Skip to main content
POST
Get Insight Experience Score Benchmark

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.

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.

reviewSources
string[]

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

ratings
string[]

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

Response

OK

actual
object

Current performance metrics

compare
object

Comparison period metrics