POST /v1/reports/usage
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. |
count |
String | Yes |
The number of reviews to query |
business_id |
Number | Yes |
Id of the Business. |
sindex |
Number | Yes |
The starting index of the reviews |
reportType |
String | Yes |
The type of Report - Summary or Tabular. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
reviewSiteAllFlag |
Boolean | No |
Pass true if you want to get data from all sources. |
endDate |
String | No |
End date. |
days |
Number | No |
Use to get results for last some days. |
groupByDays |
Number | No |
Group by days. |
reviewSites[] |
Array | No |
List of review sites. |
startDate |
String | No |
Start date. |
ratings[] |
Array | No |
List of ratings. |
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.