POST /v1/listing/insights
Servers
- https://api.birdeye.com/resources
Request headers
Name | Type | Required | Description |
---|---|---|---|
Accept |
String | No |
e.g. application/json |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
Name | Type | Required | Description |
---|---|---|---|
api_key |
String | Yes |
Partner specific API key provided by Birdeye for data exchange. |
businessId |
Number | Yes |
Id of the account. |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
endDate |
String | No |
End Date, Format: yyyy-MM-dd. If startDate and endDate are not provided, then the last 3 months date range will be chosen. |
viewMode |
Object | Yes |
for mobile or desktop or both (if none is provided then data for both will be displayed) Example “Desktop”, ”Mobile” |
startDate |
String | No |
Start Date, Format: yyyy-MM-dd. |
businessNumbers[] |
Array | No |
Location numbers of enterprise locations. If empty all valid enterprise locations will be selected. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.