POST /v1/listing/{businessNumber}/gmb/keywords
Servers
- https://api.birdeye.com/resources
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
businessNumber |
String | Yes |
Account Business Number. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
api_key |
String | No |
e.g. - Partner specific API key provided by Birdeye for data exchange. |
Accept |
String | No |
e.g. application/json |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
order |
String | No |
Possible values “asc” or “desc”. |
limit |
Number | No |
Specify number of records to return. |
sortby |
String | No |
Possible values “frequency” or “keyword”. |
startIndex |
Number | No |
Index to start search from. Default value 0. |
keywordsSearch |
String | No |
To search by keywords that may also exist in search phrases, including the keyword itself. |
selectedMonth[] |
Array | Yes |
Filter months for which keyword data is required |
selectedkeywords[] |
Array | No |
Gives you keyword count for the selected keywords. keywordsSearch: To search by keywords that may also exist in search phrases, including the keyword itself. |
businessNumbers[] |
Array | No |
list of the unique business ids associated with a business. |
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.