Skip to main content
POST
Get Search AI Businesses

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 businessNumber

Content-Type
string
default:application/json

Media type of the JSON request body.

Body

application/json
businessNumbers
string

Comma-separated list of business numbers to retrieve the report for.

aiModel
string

Possible values are [CHATGPT, GEMINI, PERPLEXITY]

theme
string

Specifies the theme or category used to filter the report data.

pageNo
string

Specifies the page number for paginated results. Defaults to 1.

pageSize
string

Defines the number of records to be returned per page. Defaults to 25.

startDate
string

Start date for the report range (format: mm/dd/yyyy).

endDate
string

End date for the report range (format: mm/dd/yyyy).

viewReportType
string

Defines the level at which the report is generated. Allowed values: LOCATION_LEVEL, ACCOUNT_LEVEL

startDate - Start date for the report range (format
any

Start date for the report range (format: mm/dd/yyyy).

endDate - End date for the report range (format
any

End date for the report range (format: mm/dd/yyyy).

viewReportType - Defines the level at which the report is generated. Allowed values
any

Defines the level at which the report is generated. Allowed values: LOCATION_LEVEL, ACCOUNT_LEVEL

Response

OK

data
object[]
total
number