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

business_id
number
required

Id of the Business.

reportType
string
required

The type of Report - Summary or Tabular.

sindex
number
required

The starting index of the reviews

count
string
required

The number of reviews to query

Body

application/json
startDate
string

Start date.

endDate
string

End date.

reviewSites
any[]

List of review sites.

ratings
any[]

List of ratings.

days
number

Use to get results for last some days.

groupByDays
number

Group by days.

reviewSiteAllFlag
boolean

Pass true if you want to get data from all sources.

Response

OK

name
string
alias1
string
emailSentInfo
object
emailOpenInfo
object
emailClickInfo
object
rcmdReviewsCount
object[]
nonRcmdReviewsCount
object[]
smsSentInfo
object
smsOpenInfo
object
smsClickInfo
object
totalReviewsCount
number
Example: