Skip to main content
POST
Archived Get Reviews

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 business number.

Content-Type
string
default:application/json

Media type of the JSON request body.

Query Parameters

includeNonAggregatedReviews
boolean

Include reviews whose auto-crawling is blocked. Default is false.

sindex
integer

Start index of the reviews. Default is 0.

count
integer

Number of reviews to fetch. Default is 10000.

sortby
integer

Sort field identifier. Default is 7.

sortorder
integer

Sort order identifier. Default is 1.

Body

application/json
businessNumbers
any[]

List of business numbers to filter the report. If empty, all accessible business numbers are considered.

startDate
number

Review Start date in milliseconds, pass epoch timestamp.

endDate
number

Review End date in milliseconds, pass epoch timestamp.

sourceAlias
any[]

List of review source aliases to include.

deleteStartDate
number

Review deletion start date in milliseconds, pass epoch timestamp.

deleteEndDate
number

Review deletion end date in milliseconds, pass epoch timestamp.

ratings
any[]

Review ratings to filter. Possible values are 0,1,2,3,4,5.

statuses
any[]

Review status filter. Valid values are "published", "parked". If omitted, default is "published" only (featured reviews). "published" refers to featured reviews and "parked" refers to non-featured reviews.

searchStr
string

Free-text search term for review content.

Response

OK

reviewId
string

Unique identifier of the archived review.

rating
number

Rating given in the review.

comments
string

Review comment text.

Recommendation flag for supported sources.

status
string

Review status label returned for the review record.

reviewer
object

Reviewer details.

sourceType
string

Human-readable source name.

reviewDate
string

Review creation date.

rDate
number

Review creation timestamp in milliseconds.

archiveDate
string

Date when the review was archived.

deleteDate
string

Date when the review will be deleted from archive.

response
string

Business response text, if available.

responseDate
string

Business response date, if available.

businessId
string

Business identifier linked to the review.

businessName
string

Business name linked to the review.

businessType
string

Business type linked to the review.

customerId
number

Customer identifier mapped to the review, if available.

medias
object[]

Media attached to the review.