Skip to main content
POST
Social Open URL Performance Report

Headers

Accept
string

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.

Body

application/json
startDate
string
required

Start date in MM/dd/YYYY format.

endDate
string
required

End date in MM/dd/YYYY format.

sourceNames
any[]

List of social channels to include in the report.

businessNumbers
any

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

comparisonFilter
object

Comparison date range.

page
number

Page number for location-level data points.

size
number

Number of records per page.

Response

OK

summary
object
dataPoints
any[]

Location-level report data for actual and comparison periods.