Skip to main content
POST
Review Response Rate By Location Overview

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

Content-Type
string
default:application/json

Media type of the JSON request body.

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.

Response

OK

summary
object
dataPoints
object[]

Location-wise response-rate metrics.

dataPresent
boolean

Indicates whether report data is present.