Skip to main content
POST
NPS 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

totalCount
number

Total number of promoters, passives, and detractors.

avgNpsScore
number

Average NPS score.

promoters
number

Total number of promoters.

passives
number

Total number of passives.

detractors
number

Total number of detractors.

dataPoints
object[]

Data points.

groupByType
string

Grouping by.

dateDiff
number

Date difference.

totalPages
number

Total number of pages.

page
number

Current Page.

size
number

Size.