Skip to main content
POST
Review Response Rate By Location Overview

Headers

Accept
string

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] Business number of the location.

Query Parameters

order
number

Sort order. 1 for descending, 0 for ascending.

sortBy
string

Field used for sorting, for example rate.

startIndex
number

Starting index for pagination.

size
number

Number of records to return.

Body

application/json
reviewSites
any[]

List of review site IDs.

ratings
any[]

Ratings to include in the report.

businessNumbers
any[]

List of business numbers.

startDate
string

Start date in MM/dd/YYYY format.

endDate
string

End date in MM/dd/YYYY format.

comparisonFilter
object

Comparison date range.

Response

OK

summary
object
dataPoints
any[]

Location-wise response-rate metrics.

dataPresent
boolean

Indicates whether report data is present.