About this integration
Reputation and local marketing for multi-location businesses — collect and reply to reviews, sync listings across 50+ directories, manage contacts and campaigns, run surveys and tickets, publish social posts, and pull reputation, listings and competitor reports. Use it from the workflow canvas with no custom glue script required.
This integration exposes 2 triggers, 89 search modules and 78 actions as workflow nodes. Authentication uses basic authentication. Webhook-based triggers fire instantly without polling.
How to connect
The credential form asks for API Key and Account Business Number.
Prefer the interactive builder form? Open it on the app page.
Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.
| Field | Type | Help |
|---|---|---|
API KeyRequired | password | dashboard → Settings → API. The key is confidential; Birdeye requires it be sent only from a backend server. |
Account Business NumberRequired | text | Your account business number (not a location number). Used as the default business for every module; each module can override it. |
Use it in workflow automation
Start with Watch Conversation Events, then add Add Aggregation Source.
Triggers, searches and actions
Use the tables below to inspect Birdeye's 2 triggers, 89 search modules, and 78 actions.
Triggers
2 triggers fire automatically when specified events occur — no polling or cron job needed.
- Watch Conversation Events
- Watch Events
Searches
Fetch data on demand using 89 search modules that query the app during a run.
- Get Average Response Time By Location
- Get Average Response Time Over Time
- Get Birdeye Impressions
- Get Business
- Get Business Dashboard Report
84more searches
Actions
78 action modules cover the full range of create, update, and delete operations.
- Add Aggregation Source
- Add Business Integration Mapping
- Add Business Media
- Add Competitor Aggregation Source
- Add Products To Locations
73more actions
Explore the fields available for each Birdeye trigger, search, and action.
Triggers
No fields documented.
No fields documented.
Searches
Input fields
| Field | Type |
|---|---|
Business ID | text |
Sort Order | choice |
Sort By | text |
Start Index | number |
Page Size | number |
Review Sites | array |
Review Site ID | text |
Ratings | text |
6other input fields
Output fields
| Field | Type |
|---|---|
Location Label | text |
Average Response Time | object |
Days | number |
Hours | number |
Minutes | number |
Responded Count | number |
Business Number | number |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Review Sites | array |
Review Site ID | text |
Ratings | text |
Business Numbers | choice |
Start Date | date |
End Date | date |
Comparison Start Date | date |
2other input fields
Output fields
| Field | Type |
|---|---|
Period Label | text |
Short Label | text |
Period Start | text |
Period End | text |
Average Response Time | object |
Days | number |
Hours | number |
Minutes | number |
Responded Count | number |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Business NumbersRequired | choice |
Start DateRequired | text |
End DateRequired | text |
Limit | number |
Start Index | number |
Sort By | text |
1other input field
Output fields
| Field | Type |
|---|---|
Location Name | text |
Count | text |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Output fields
| Field | Type |
|---|---|
Business ID | number |
Name | text |
Alias | text |
Email ID | text |
Phone | text |
Fax | text |
Website URL | text |
21other output fields
Input fields
| Field | Type |
|---|---|
Business ID | text |
Output fields
| Field | Type |
|---|---|
All-Time Stats | object |
Last 30 Days Stats | object |
Recent Negative Reviews | array |
Review ID | text |
Rating | number |
Comments | text |
Review URL | url |
Review Date | text |
Response | text |
Source Type | text |
Reviewer | object |
Recent Positive Reviews | array |
Review ID | text |
Rating | number |
Comments | text |
Review URL | url |
Review Date | text |
Response | text |
Source Type | text |
Reviewer | object |
Syndication | object |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Output fields
| Field | Type |
|---|---|
ID | number |
Name | text |
Alias | text |
Address | text |
Phone | text |
Status | text |
Created On | text |
4other output fields
Input fields
| Field | Type |
|---|---|
Contact IDRequired | choice |
Survey ID | number |
Template ID | number |
Check-in ID | number |
Business Number | text |
Output fields
| Field | Type |
|---|---|
External URL ID | number |
URL | text |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Source Type | choice |
Aggregation Sources | array |
Time Period | text |
Start Date | date |
End Date | date |
Competitors | array |
Output fields
| Field | Type |
|---|---|
Categories | array |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Source Type | choice |
Aggregation Sources | array |
Time Period | text |
Start Date | date |
End Date | date |
Competitors | array |
4other input fields
Output fields
| Field | Type |
|---|---|
Business ID | text |
Enterprise Name | text |
Keywords | array |
Count | number |
Average Score | number |
Keyword Stats | array |
Negative Keyword Adjectives | array |
1other output field
Input fields
| Field | Type |
|---|---|
Business ID | text |
Source Type | choice |
Aggregation Sources | array |
Time Period | text |
Start Date | date |
End Date | date |
Competitors | array |
3other input fields
Output fields
| Field | Type |
|---|---|
Business ID | text |
Enterprise Name | text |
Themes | array |
Occurrence | number |
Average Score | number |
Positive Percentage | number |
Negative Percentage | number |
6other output fields
Input fields
| Field | Type |
|---|---|
Business ID | text |
Start Date | date |
End Date | date |
Review Sites | array |
Review Site ID | text |
Output fields
| Field | Type |
|---|---|
Positive Count | number |
Neutral Count | number |
Negative Count | number |
Positive Percent | number |
Neutral Percent | number |
Negative Percent | number |
Business Name | text |
3other output fields
Input fields
| Field | Type |
|---|---|
Business ID | text |
Start Index | number |
Page Size | number |
Sort Order | choice |
Business Numbers | choice |
From Date | date |
To Date | date |
4other input fields
Output fields
| Field | Type |
|---|---|
Business Locations | array |
Competitor Location | text |
Competitor Brand | text |
Source | text |
Overall Rating | number |
Review Count | number |
Input fields
| Field | Type |
|---|---|
Contact ID | text |
Location Mapping ID | text |
Email | text |
Phone | text |
Include Experience Score | boolean |
Business Number | text |
Output fields
| Field | Type |
|---|---|
ID | text |
First Name | text |
Last Name | text |
Email | text |
Phone | text |
Country Code | text |
Blocked | boolean |
10other output fields
Input fields
| Field | Type |
|---|---|
Contact ID | text |
Location Mapping ID | text |
Email | text |
Phone | text |
Business Number | text |
Output fields
| Field | Type |
|---|---|
ID | text |
First Name | text |
Last Name | text |
Email | text |
Phone | text |
Country Code | text |
Blocked | boolean |
9other output fields
Input fields
| Field | Type |
|---|---|
Business Number | text |
Field IDRequired | text |
Output fields
| Field | Type |
|---|---|
ID | number |
Field Value | text |
Field Name | text |
Type | text |
Default Value | text |
Field Description | text |
Filterable | boolean |
Input fields
| Field | Type |
|---|---|
EmailRequired | text |
Output fields
| Field | Type |
|---|---|
Email ID | text |
First Name | text |
Last Name | text |
Phone | text |
User Role | text |
Business List | array |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Business Numbers | choice |
MonthsRequired | array |
Selected Keywords | array |
Keyword Search | text |
Limit | number |
Start Index | number |
2other input fields
Output fields
| Field | Type |
|---|---|
Keyword | text |
Frequency | number |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Output fields
| Field | Type |
|---|---|
Result | text |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Business NumbersRequired | choice |
Start DateRequired | date |
End DateRequired | date |
User EmailRequired | choice |
Review Sources | array |
Ratings | choice |
3other input fields
Output fields
| Field | Type |
|---|---|
Location Business Number | text |
Location Name | text |
Experience Score | number |
Listing Score | number |
Sentiment Score | number |
Reputation Score | number |
Previous Period Experience Score | number |
7other output fields
Input fields
| Field | Type |
|---|---|
Business ID | text |
Business NumbersRequired | choice |
Start DateRequired | date |
End DateRequired | date |
Review Sources | array |
Ratings | choice |
Hierarchy Node Filters | array |
2other input fields
Output fields
| Field | Type |
|---|---|
Start Date | text |
End Date | text |
Label | text |
Short Label | text |
Experience Score | number |
Sentiment | object |
Score | number |
Reputation | object |
Score | number |
2other output fields
Input fields
| Field | Type |
|---|---|
Business ID | text |
Business NumbersRequired | choice |
Start DateRequired | date |
End DateRequired | date |
Review Sources | array |
Ratings | choice |
Output fields
| Field | Type |
|---|---|
Actual | object |
Sentiment Score | number |
Reputation Score | number |
Experience Score | number |
Listing Score | number |
Industry Sentiment Score | number |
Industry Reputation Score | number |
Industry Experience Score | number |
Compare | object |
Sentiment Score | number |
Reputation Score | number |
Experience Score | number |
Listing Score | number |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Start Date | date |
End Date | date |
Review Sites | array |
Review Site ID | text |
Business Numbers | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Location Alias | text |
Average Score | number |
Grade | text |
Total Count | number |
Metrics By Category | object |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Output fields
| Field | Type |
|---|---|
Business Info | object |
Additional Info | object |
Media | object |
Opt-Out Flags | object |
COVID Info | object |
Bing Listing | object |
Internal Listing | object |
6other output fields
Input fields
| Field | Type |
|---|---|
Business Number | text |
Business Numbers | choice |
Start Date | text |
End Date | text |
View ModeRequired | text |
Output fields
| Field | Type |
|---|---|
Map View Total Count | number |
Search View Total Count | number |
Website Visits Total Count | number |
Get Directions Total Count | number |
Calls Total Count | number |
Users Reached Total Count | number |
Users Engaged Total Count | number |
6other output fields
Input fields
| Field | Type |
|---|---|
Report TypeRequired | choice |
Business Number | text |
Business Numbers | choice |
Start Date | text |
End Date | text |
View Mode | text |
Group By | text |
1other input field
Output fields
| Field | Type |
|---|---|
Label | text |
Website Visits Count | number |
Directions Count | number |
Calls Count | number |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Output fields
| Field | Type |
|---|---|
Business Name | text |
Activation Status | text |
Last Updated | text |
Location Status | text |
Publish Listings | text |
Errors | array |
Total Sites | number |
11other output fields
Input fields
| Field | Type |
|---|---|
Business ID | text |
Start Date | date |
End Date | date |
Review Sites | array |
Review Site ID | text |
Business Numbers | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Node ID | number |
Location Label | text |
Dynamic Label | object |
Detractor Percentile | number |
Passive Percentile | number |
Promoter Percentile | number |
NPS Score | number |
5other output fields
Input fields
| Field | Type |
|---|---|
Business ID | text |
Start Date | date |
End Date | date |
Review Sites | array |
Review Site ID | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
Period Label | text |
Short Label | text |
Period Start | text |
Period End | text |
Detractor Percentile | number |
Passive Percentile | number |
Promoter Percentile | number |
5other output fields
Input fields
| Field | Type |
|---|---|
Product IdentifierRequired | choice |
Business Number | text |
Output fields
| Field | Type |
|---|---|
Product ID | text |
Product SKU | text |
Location Count | number |
Title | text |
Description | text |
Product URL | text |
Image Link | text |
12other output fields
Input fields
| Field | Type |
|---|---|
Business ID | text |
Sort By | choice |
Sort Order | choice |
Source Aliases | array |
Source Alias | text |
Business Numbers | choice |
Last N Days | number |
Limit | number |
Output fields
| Field | Type |
|---|---|
Average Rating | number |
Review Count | number |
Date | text |
Input fields
| Field | Type |
|---|---|
Business ID | text |
From Date | date |
To Date | date |
Last N Days | number |
Last N Months | number |
Output fields
| Field | Type |
|---|---|
Email Sent Info | object |
Email Open Info | object |
Email Click Info | object |
Reviews By Source | array |
Source Name | text |
Source Alias | text |
Average Rating | number |
Review Count | number |
SMS Detail | object |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Business Numbers | choice |
Source Alias | text |
From Date | date |
To Date | date |
Output fields
| Field | Type |
|---|---|
Total Review Count | number |
Count By Rating | array |
Rating | number |
Count | number |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Business Numbers | choice |
Source Alias | text |
From Date | date |
To Date | date |
Employees | array |
First Name | text |
Last Name | text |
Phone | text |
Output fields
| Field | Type |
|---|---|
Employees | array |
Employee | object |
Count By Rating | array |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Source Aliases | array |
Source Alias | text |
Business Numbers | choice |
Last N Months | number |
Limit | number |
Output fields
| Field | Type |
|---|---|
Review Count | number |
Location Name | text |
Business ID | text |
Counts By Source | array |
Source Alias | text |
Count | number |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Sort Order | choice |
Sort By | text |
Start Index | number |
Page Size | number |
Review Sites | array |
Review Site ID | text |
Ratings | text |
6other input fields
Output fields
| Field | Type |
|---|---|
Location Label | text |
Total Count | number |
Response Rate | number |
Unresponded Rate | number |
Unresponded Count | number |
Responded Count | number |
Business Number | number |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Review Sites | array |
Review Site ID | text |
Ratings | text |
Business Numbers | choice |
Start Date | date |
End Date | date |
Comparison Start Date | date |
2other input fields
Output fields
| Field | Type |
|---|---|
Period Label | text |
Short Label | text |
Total Count | number |
Period Start | text |
Period End | text |
Response Rate | number |
Unresponded Count | number |
4other output fields
Input fields
| Field | Type |
|---|---|
Business ID | text |
Sort By | choice |
Sort Order | choice |
Source Aliases | array |
Source Alias | text |
Business Numbers | choice |
Last N Months | number |
Limit | number |
Output fields
| Field | Type |
|---|---|
Rating | number |
Review Count | number |
Location Name | text |
Business ID | number |
State | text |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Statuses | text |
Output fields
| Field | Type |
|---|---|
Sources | array |
Source Name | text |
Source Alias | text |
Average Rating | number |
Review Count | number |
Ratings | array |
Rating | number |
Review Count | number |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Page Size | number |
Start Index | number |
Business Numbers | choice |
AI Models | choice |
Start Date | date |
End Date | date |
Output fields
| Field | Type |
|---|---|
Total | number |
Has Next | boolean |
Data | text |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Output fields
| Field | Type |
|---|---|
Frequency | text |
Quota | number |
Billing Type | text |
Themes | array |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Page Size | number |
Start Index | number |
Business Numbers | choice |
AI Models | choice |
Start Date | date |
End Date | date |
1other input field
Output fields
| Field | Type |
|---|---|
Total | number |
Has Next | boolean |
Data | text |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Batch IDRequired | text |
Output fields
| Field | Type |
|---|---|
Batch ID | text |
Status | text |
Accepted Count | number |
Success Count | number |
Failed Count | number |
Pending Count | number |
Items | array |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Start DateRequired | text |
End DateRequired | text |
Social Channels | array |
Business Numbers | choice |
Comparison Date Range | object |
Page | number |
2other input fields
Output fields
| Field | Type |
|---|---|
Location Label | text |
Start Date | text |
End Date | text |
Location ID | number |
Business Number | text |
External Reference ID | text |
Channel-Wise Data | object |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Tracking IDRequired | text |
Output fields
| Field | Type |
|---|---|
Tracking ID | text |
Account Number | text |
Social Site | text |
Sub-Business Numbers | array |
Social Post Details | array |
Input fields
| Field | Type |
|---|---|
Survey IDRequired | choice |
Business ID | text |
Locale | text |
Output fields
| Field | Type |
|---|---|
Survey ID | number |
Logo URL | text |
Name | text |
Status | text |
Created (epoch ms) | number |
Last Modified (epoch ms) | number |
Response Count | number |
5other output fields
Input fields
| Field | Type |
|---|---|
Business ID | text |
Report TypeRequired | choice |
Start IndexRequired | number |
CountRequired | number |
Start Date | date |
End Date | date |
Review Sites | array |
Review Site ID | text |
5other input fields
Output fields
| Field | Type |
|---|---|
Location Name | text |
Location Alias | text |
Email Sent Info | object |
Email Open Info | object |
Email Click Info | object |
Recommended Reviews Count | array |
Source ID | number |
Source Name | text |
Source Alias | text |
Average Rating | number |
Review Count | number |
Non-Recommended Reviews Count | array |
Source ID | number |
Source Name | text |
Source Alias | text |
Average Rating | number |
Review Count | number |
4other output fields
Input fields
| Field | Type |
|---|---|
Business ID | text |
Source Aliases | array |
Source Alias | text |
Business Numbers | choice |
Last N Months | number |
Limit | number |
Output fields
| Field | Type |
|---|---|
Visitor Count | number |
Location Name | text |
Business ID | text |
Visitors By Source | array |
Source Alias | text |
Count | number |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
Alias | text |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | number |
Source Alias | text |
Source URL | text |
Source Name | text |
Status | number |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Start Index | number |
Count | number |
Order | choice |
Business Numbers | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Question | object |
Text | text |
Updated Date | text |
Answers | array |
All Locations | boolean |
Source | text |
Source Type | text |
Source Value | text |
Business Numbers | array |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Output fields
| Field | Type |
|---|---|
Attribute Groups | object |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Business Numbers | choice |
Include Non-Aggregated Reviews | boolean |
Start Index | number |
Count | number |
Sort Field | number |
Sort Order | number |
9other input fields
Output fields
| Field | Type |
|---|---|
Review ID | text |
Rating | number |
Comments | text |
Recommended | number |
Status | text |
Reviewer | object |
First Name | text |
Last Name | text |
Nick Name | text |
Thumbnail URL | url |
Source Type | text |
11other output fields
Input fields
| Field | Type |
|---|---|
Business ID | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
Enterprise Business Number | text |
Enterprise Name | text |
Business Competitors | array |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
Media ID | text |
URL | text |
Media Category | text |
Description | text |
Media Format | text |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | number |
Name | text |
Alias | text |
Address | object |
Address1 | text |
Address2 | text |
Sub Locality | text |
City | text |
State | text |
Zip | text |
Country Code | text |
Country Name | text |
Phone | text |
Type | text |
Status | text |
2other output fields
Input fields
| Field | Type |
|---|---|
Business ID | text |
Start Index | number |
Page Size | number |
Sort Order | choice |
Business Numbers | choice |
From Date | date |
To Date | date |
4other input fields
Output fields
| Field | Type |
|---|---|
Business Locations | array |
Competitor Location | text |
Competitor Brand | text |
Source | text |
Rating | number |
Review Comment | text |
Reviewer Name | text |
2other output fields
Input fields
| Field | Type |
|---|---|
Business ID | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
Business ID | text |
Business Name | text |
Business Alias | text |
Address | object |
Address Line 1 | text |
Address Line 2 | text |
City | text |
State | text |
Country Code | text |
Zip Code | text |
Country Name | text |
Phone | text |
Account Type | text |
Status | text |
3other output fields
Input fields
| Field | Type |
|---|---|
Business ID | text |
Start IndexRequired | number |
CountRequired | number |
From Date | date |
To Date | date |
Updated From Date | date |
Updated To Date | date |
6other input fields
Output fields
| Field | Type |
|---|---|
Review ID | text |
Rating | number |
Comments | text |
Title | text |
Reviewer | object |
First Name | text |
Last Name | text |
Nickname | text |
Thumbnail URL | text |
Email | text |
Facebook ID | text |
City | text |
State | text |
Review URL | text |
Source Type | text |
8other output fields
Input fields
| Field | Type |
|---|---|
Contact IDRequired | choice |
Start Date | text |
End Date | text |
Limit | number |
Business Number | text |
Output fields
| Field | Type |
|---|---|
Type | text |
Activity Date | text |
Action | text |
Activity Timestamp | number |
Input fields
| Field | Type |
|---|---|
PageRequired | number |
Page SizeRequired | number |
Sort ByRequired | text |
Start Date | text |
End Date | text |
Limit | number |
Business Number | text |
Output fields
| Field | Type |
|---|---|
Contact ID | number |
Name | text |
Email | text |
Phone | text |
Last Activity | text |
Input fields
| Field | Type |
|---|---|
Include Tag Data | boolean |
Include Custom Field Data | boolean |
Sources | text |
Start Date (UTC)Required | text |
End Date (UTC)Required | text |
Contact Type | choice |
PageRequired | text |
3other input fields
Output fields
| Field | Type |
|---|---|
First Name | text |
Last Name | text |
Email | text |
Phone | text |
Created | date |
Contact Type | text |
Source | text |
1other output field
Input fields
| Field | Type |
|---|---|
Start Date | text |
End Date | text |
Message Offset | number |
Message Page Size | number |
Contact Filter | object |
Phone | text |
Email | text |
Exclude Campaign Messages | boolean |
Limit | number |
1other input field
Output fields
| Field | Type |
|---|---|
Conversation ID | number |
Contact | object |
Contact ID | number |
Name | text |
First Name | text |
Last Name | text |
Phone | text |
Email | text |
Created Date | text |
Updated Date | text |
Team | text |
Location ID | number |
Messages | array |
Sent At | number |
ID | text |
Text | text |
Message Date | text |
Attachments | text |
Direction | text |
Channel | text |
Conversation Start Date | text |
Last Message Received On | text |
Status | text |
Last Used Channel | text |
1other output field
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Event ID | number |
Event Name | text |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
Card ID | number |
Title | text |
Description | text |
Image URL | text |
Image Position | text |
Is Visible | number |
Click URL | text |
1other output field
Input fields
| Field | Type |
|---|---|
Business Number | text |
PageRequired | number |
SizeRequired | number |
Search String | text |
Sort By | text |
Order By | choice |
Output fields
| Field | Type |
|---|---|
ID | number |
Field Value | text |
Field Name | text |
Type | text |
Default Value | text |
Field Description | text |
Filterable | boolean |
1other output field
Input fields
| Field | Type |
|---|---|
Business Number | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
First Name | text |
Last Name | text |
Email ID | text |
Phone | text |
Image URL | text |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
Business ID | text |
Business Name | text |
Competitor ID | text |
Business Alias | text |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Category IDRequired | choice |
Country CodeRequired | choice |
Output fields
| Field | Type |
|---|---|
Attribute Groups | object |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Start IndexRequired | number |
Page SizeRequired | number |
Limit | number |
Output fields
| Field | Type |
|---|---|
Question ID | number |
Answered By Owner | boolean |
Asked By Owner | boolean |
Question | text |
Updated By | text |
Time | text |
Updated On | text |
5other output fields
Input fields
| Field | Type |
|---|---|
Business ID | text |
Start IndexRequired | number |
Page SizeRequired | number |
Sort ByRequired | choice |
Sort OrderRequired | choice |
Search | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
Service ID | text |
Name | text |
Currency Code | text |
Price | number |
Description | text |
Group | text |
Duration (minutes) | number |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Output fields
| Field | Type |
|---|---|
Hotel Attributes | object |
Input fields
| Field | Type |
|---|---|
Business Number | text |
SourceRequired | choice |
Country CodeRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Primary | boolean |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Channel | choice |
Limit | number |
Input fields
| Field | Type |
|---|---|
StartRequired | date |
EndRequired | date |
Subscription StatusRequired | array |
Status | text |
Business Number | text |
Output fields
| Field | Type |
|---|---|
Email Opt-Outs | array |
ID | number |
First Name | text |
Last Name | text |
Email | text |
Phone | text |
Text Opt-Outs | array |
ID | number |
First Name | text |
Last Name | text |
Email | text |
Phone | text |
Blocked | array |
ID | number |
First Name | text |
Last Name | text |
Email | text |
Phone | text |
Input fields
| Field | Type |
|---|---|
StartRequired | date |
EndRequired | date |
Subscription StatusRequired | array |
Status | text |
Business Number | text |
Output fields
| Field | Type |
|---|---|
Email Opt-Outs | array |
ID | number |
First Name | text |
Last Name | text |
Email | text |
Phone | text |
Opted Out From | array |
Text Opt-Outs | array |
ID | number |
First Name | text |
Last Name | text |
Email | text |
Phone | text |
Opted Out From | array |
Blocked | array |
ID | number |
First Name | text |
Last Name | text |
Email | text |
Phone | text |
Opted Out From | array |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Business Numbers | choice |
Search | text |
Status | text |
Page Size | number |
Page Number | number |
Limit | number |
Output fields
| Field | Type |
|---|---|
Product ID | text |
Product SKU | text |
Location Count | number |
Title | text |
Description | text |
Product URL | text |
Image Link | text |
10other output fields
Input fields
| Field | Type |
|---|---|
Business ID | text |
Start IndexRequired | number |
CountRequired | number |
Include Non-Aggregated Reviews | boolean |
From Date | date |
To Date | date |
From Timestamp | date |
14other input fields
Output fields
| Field | Type |
|---|---|
Review ID | text |
Rating | number |
Comments | text |
Title | text |
Reviewer | object |
First Name | text |
Last Name | text |
Nick Name | text |
Thumbnail URL | url |
Email | |
Facebook ID | text |
City | text |
State | text |
Review URL (lowercase url) | url |
Review URL (uppercase URL) | url |
10other output fields
Input fields
| Field | Type |
|---|---|
Business ID | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
Tag | text |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
Run Date | text |
Themes | array |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Business Numbers | choice |
AI Model | choice |
Theme | choice |
Page Number | number |
Page Size | number |
Start Date | date |
3other input fields
Output fields
| Field | Type |
|---|---|
Theme | text |
Prompt | text |
AI Model | text |
Business Number | text |
Processed Date | text |
Businesses | array |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Business Numbers | choice |
AI Model | choice |
Theme | choice |
Page Number | number |
Page Size | number |
Start Date | date |
3other input fields
Output fields
| Field | Type |
|---|---|
Theme | text |
Prompt | text |
AI Model | text |
Business Number | text |
Processed Date | text |
Citations | array |
Input fields
| Field | Type |
|---|---|
Survey IDRequired | choice |
Business Number | text |
Page | number |
Page Size | number |
Sort By | text |
Sort Order | choice |
Include Ticket IDs | boolean |
3other input fields
Output fields
| Field | Type |
|---|---|
Response ID | number |
Request Date | text |
Response Date | text |
Completed | boolean |
Question Count | number |
Locale | text |
Survey ID | number |
10other output fields
Input fields
| Field | Type |
|---|---|
Business ID | text |
Sort By | choice |
Sort Order | choice |
Search | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
Survey ID | number |
Name | text |
Status | text |
Created (epoch ms) | number |
Last Modified (epoch ms) | number |
Response Count | number |
Question Count | number |
Input fields
| Field | Type |
|---|---|
Business Number | text |
OperationRequired | choice |
Start IndexRequired | number |
Sort ByRequired | choice |
Sort OrderRequired | choice |
Include Total CountRequired | boolean |
Assignees | choice |
9other input fields
Output fields
| Field | Type |
|---|---|
Ticket ID | number |
Status | text |
Rating | number |
External ID | text |
Date | text |
Posted On | text |
Update Date | text |
10other output fields
Input fields
| Field | Type |
|---|---|
Business Number | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
Value | text |
Label | text |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Start IndexRequired | number |
Page SizeRequired | number |
Limit | number |
Output fields
| Field | Type |
|---|---|
Question ID | number |
Answered By Owner | boolean |
Asked By Owner | boolean |
Question | text |
Updated By | text |
Time | text |
Updated On | text |
5other output fields
Input fields
| Field | Type |
|---|---|
Business Number | text |
Business Numbers | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Business Number | text |
Account Number | text |
Menu Details | object |
Created At | date |
Updated At | date |
CRM Name | text |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Search String | text |
Sort By | text |
Sort Order | choice |
Start Index | number |
Page Size | number |
Limit | number |
Output fields
| Field | Type |
|---|---|
Name | text |
Status | text |
Created At | text |
Created By | text |
Business Number | number |
Type | text |
Actions
Input fields
| Field | Type |
|---|---|
Business ID | text |
Source AliasRequired | text |
Source URLRequired | text |
Output fields
| Field | Type |
|---|---|
ID | number |
Source Alias | text |
Source Name | text |
Source URL | text |
Body | text |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Integration Group IDRequired | number |
ActiveRequired | boolean |
Integration Properties | array |
Input fields
| Field | Type |
|---|---|
Business Number | text |
MediaRequired | array |
Output fields
| Field | Type |
|---|---|
Media | array |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Competitor Account IDRequired | choice |
Source AliasRequired | text |
Source URLRequired | url |
Output fields
| Field | Type |
|---|---|
Aggregation ID | text |
Source Alias | text |
Source Name | text |
Source URL | text |
Source ID | number |
Competitor Account ID | text |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Product IDsRequired | choice |
Output fields
| Field | Type |
|---|---|
Code | number |
Message | text |
Input fields
| Field | Type |
|---|---|
Business Number | text |
CommentRequired | text |
Ticket IDRequired | choice |
User EmailRequired | choice |
Output fields
| Field | Type |
|---|---|
Ticket ID | number |
Input fields
| Field | Type |
|---|---|
Business ID | text |
TagRequired | choice |
Review IDs | array |
Review ID | text |
From Date | date |
To Date | date |
Updated From Date | date |
Updated To Date | date |
5other input fields
Input fields
| Field | Type |
|---|---|
Business Number | text |
Field IDRequired | number |
Field ValueRequired | text |
Output fields
| Field | Type |
|---|---|
ID | number |
Field Name | text |
Type | text |
Field Value | text |
Default Value | text |
Is Hidden | boolean |
All Businesses | boolean |
1other output field
Input fields
| Field | Type |
|---|---|
Business Number | text |
Business EmailRequired | text |
Business NameRequired | text |
ZIP CodeRequired | text |
Business Type | text |
PhoneRequired | text |
Entity Category | text |
2other input fields
Output fields
| Field | Type |
|---|---|
Business ID | number |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Output fields
| Field | Type |
|---|---|
Enterprise Competitor Business ID | text |
Template ID | number |
Is Aggregation Required | number |
Type | text |
Enterprise Competitor Business Number | text |
Competitor Account ID | text |
Business Already Present | boolean |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Location Competitor Name | text |
Location User Email | |
Location Country Code | text |
Location Phone Number | text |
Zip Code | text |
Competitor ID | choice |
1other input field
Output fields
| Field | Type |
|---|---|
Enterprise Competitor Business ID | text |
Template ID | number |
Is Aggregation Required | number |
Type | text |
Enterprise Competitor Business Number | text |
Business Already Present | boolean |
Input fields
| Field | Type |
|---|---|
Name | text |
Email | text |
Phone | text |
SMS Enabled | boolean |
Additional Params | array |
Parameter | object |
Assisted Employees | array |
Employee | object |
External ID | text |
1other input field
Output fields
| Field | Type |
|---|---|
Contact ID | number |
Input fields
| Field | Type |
|---|---|
Name | text |
Email | text |
Phone | text |
SMS Enabled | boolean |
Additional Params | array |
Parameter | object |
Assisted Employees | array |
Employee | object |
External ID | text |
3other input fields
Output fields
| Field | Type |
|---|---|
Contact ID | number |
Input fields
| Field | Type |
|---|---|
Customer Comment | text |
CustomerRequired | object |
Name | text |
Email | text |
Phone | text |
Additional Params | array |
Parameter | object |
Business Number | text |
Output fields
| Field | Type |
|---|---|
Contact ID | number |
Input fields
| Field | Type |
|---|---|
Account Business Number | text |
EventsRequired | choice |
Endpoint URL | text |
Output fields
| Field | Type |
|---|---|
Subscription ID | number |
Events | array |
Business ID | number |
Input fields
| Field | Type |
|---|---|
Business Number | text |
TitleRequired | text |
Description | text |
Image URL | text |
Image Position | number |
Is Visible | number |
Pin On Top | number |
1other input field
Output fields
| Field | Type |
|---|---|
Card ID | number |
Title | text |
Description | text |
Image URL | text |
Image Position | text |
Is Visible | number |
Pin On Top | number |
1other output field
Input fields
| Field | Type |
|---|---|
Business Number | text |
Field NameRequired | text |
Field TypeRequired | text |
Default Value | text |
Drop-Down Options | array |
Field Description | text |
Filterable | text |
Output fields
| Field | Type |
|---|---|
ID | number |
Field Name | text |
Created | number |
Updated | number |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Webhook URL | text |
Notification Emails | array |
Event Name | text |
Basic Auth | object |
Output fields
| Field | Type |
|---|---|
Subscription ID | text |
Message | text |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Question IDRequired | choice |
AnswerRequired | text |
Output fields
| Field | Type |
|---|---|
Answer ID | text |
Input fields
| Field | Type |
|---|---|
Business ID | text |
QuestionRequired | text |
AnswerRequired | text |
Output fields
| Field | Type |
|---|---|
Question ID | number |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Service NameRequired | text |
Currency Code | choice |
Price | number |
Description | text |
Group | text |
Duration (minutes) | number |
Output fields
| Field | Type |
|---|---|
Service ID | text |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Business Info | object |
Name | text |
Phone | text |
Website URL | text |
Email | text |
Is Address Hidden (Yes/No) | text |
Is Service Area Provider (Yes/No) | text |
Main Business Description | text |
Service Areas | text |
Location | object |
Additional Info | object |
Established Year | text |
Timezone | choice |
Languages | array |
More Hours | text |
Apple More Hours | text |
Open 24/7 (0/1) | text |
Hours Of Operation | text |
Special Hours | text |
Business Status | text |
Reopen Date | text |
Media | object |
Logo URL | text |
Cover Image URL | text |
GMB Cover URL | text |
Facebook Cover URL | text |
Opt-Out Flags | object |
GMB Logo Opt-Out | boolean |
Facebook Logo Opt-Out | boolean |
GMB Cover Opt-Out | boolean |
Facebook Cover Opt-Out | boolean |
GMB Profile Opt-Out | boolean |
Business Profile Opt-Out | boolean |
COVID Info | object |
Post Description | text |
COVID-19 Support Link | text |
Virtual Care Link | text |
Bing Listing | object |
Primary Category (Bing) | text |
Categories (Bing) | array |
Phone (Bing) | text |
Description (Bing) | text |
7other input fields
Input fields
| Field | Type |
|---|---|
Business Number | text |
Business Numbers | choice |
TitleRequired | text |
Description | text |
Image LinkRequired | text |
Additional Image Links | array |
Brand Name | text |
7other input fields
Output fields
| Field | Type |
|---|---|
Product ID | text |
Code | number |
Message | text |
Data | object |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Tags | choice |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Post TextRequired | text |
Social SiteRequired | text |
Sub-Business Numbers | choice |
Schedule Timestamp | number |
Media | array |
Additional Meta Data | object |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Survey Name | text |
Thank You Message | text |
Survey Type | text |
Owner Email | text |
Pages | array |
Output fields
| Field | Type |
|---|---|
Survey ID | number |
Input fields
| Field | Type |
|---|---|
Survey IDRequired | choice |
Business ID | text |
Response BodyRequired | text |
Input fields
| Field | Type |
|---|---|
Business Number | text |
External ID (Review) | number |
Assigned To (Email)Required | choice |
Ticket TypeRequired | choice |
Customer | object |
Description | text |
Source Type | choice |
2other input fields
Output fields
| Field | Type |
|---|---|
Ticket ID | number |
Input fields
| Field | Type |
|---|---|
Business Number | text |
First Name | text |
Last Name | text |
EmailRequired | text |
Phone | text |
User RoleRequired | choice |
Send Invite | text |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Aggregation IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Question IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Business Number | text |
EmailRequired | text |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Media IDsRequired | choice |
Input fields
| Field | Type |
|---|---|
Contact IDRequired | text |
Location Business IDs | choice |
Business Number | text |
Input fields
| Field | Type |
|---|---|
Contact IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Email | text |
First Name | text |
Number | text |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Card IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Field IDRequired | text |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Subscription IDRequired | text |
Output fields
| Field | Type |
|---|---|
Message | text |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Question IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Question IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Service IDsRequired | choice |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Product IDsRequired | choice |
Output fields
| Field | Type |
|---|---|
Code | number |
Message | text |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Tag NameRequired | choice |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Tracking IDRequired | text |
Sub-Business NumbersRequired | choice |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Input fields
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
Output fields
| Field | Type |
|---|---|
Body | text |
Headers | object |
Status code | number |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Google Merchant Center Account IDRequired | text |
Output fields
| Field | Type |
|---|---|
Code | number |
Message | text |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Product IDsRequired | choice |
Output fields
| Field | Type |
|---|---|
Code | number |
Message | text |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Tags | choice |
Input fields
| Field | Type |
|---|---|
Business ID | text |
TagRequired | choice |
Review IDs | array |
Review ID | text |
From Date | date |
To Date | date |
Updated From Date | date |
Updated To Date | date |
5other input fields
Input fields
| Field | Type |
|---|---|
Business ID | text |
Review IDRequired | text |
Reply Text | text |
Private Response | boolean |
Output fields
| Field | Type |
|---|---|
Response | text |
Response By | text |
Response Date (epoch ms) | number |
Input fields
| Field | Type |
|---|---|
EmailRequired | text |
Input fields
| Field | Type |
|---|---|
Business IDsRequired | choice |
Business Number | text |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Name | text |
Alias | text |
Is Address Hidden | number |
Location | object |
Address Line 1 | text |
Address Line 2 | text |
Sub-Locality | text |
City | text |
State | text |
ZIP | text |
Country Code | text |
Country Name | text |
EmailRequired | text |
PhoneRequired | text |
44other input fields
Output fields
| Field | Type |
|---|---|
Name | text |
Alias | text |
Email ID | text |
Phone | text |
Fax | text |
Website URL | text |
Description | text |
16other output fields
Input fields
| Field | Type |
|---|---|
Business Number | text |
Media IDRequired | choice |
Media CategoryRequired | text |
Input fields
| Field | Type |
|---|---|
Business Number | text |
New StatusRequired | choice |
Input fields
| Field | Type |
|---|---|
Email Preferences | object |
Marketing Opt-In | boolean |
Feedback Opt-In | boolean |
Service Opt-In | boolean |
SMS Preferences | object |
Marketing Opt-In | boolean |
Feedback Opt-In | boolean |
Service Opt-In | boolean |
SMS Opt-In | boolean |
Emails | array |
Email | text |
Phone Numbers | array |
Phone | text |
Business Number | text |
Input fields
| Field | Type |
|---|---|
PermissionRequired | choice |
Emails | array |
Email | text |
Phone Numbers | array |
Phone | text |
Business Number | text |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Card IDRequired | choice |
TitleRequired | text |
Description | text |
Image URL | text |
Image Position | text |
Is Visible | number |
4other input fields
Input fields
| Field | Type |
|---|---|
Business Number | text |
Field IDRequired | text |
Default Value | text |
Drop-Down Options | array |
Field Description | text |
Filterable | text |
Is Hidden | text |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Question IDRequired | choice |
AnswerRequired | text |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Question IDRequired | choice |
QuestionRequired | text |
Input fields
| Field | Type |
|---|---|
Business ID | text |
Service IDRequired | choice |
Service NameRequired | text |
Currency Code | choice |
Price | number |
Description | text |
Group | text |
1other input field
Input fields
| Field | Type |
|---|---|
Business ID | text |
Category NameRequired | choice |
Service IDsRequired | choice |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Level | text |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Business Info | object |
Name | text |
Phone | text |
Website URL | text |
Email | text |
Is Address Hidden (Yes/No) | text |
Is Service Area Provider (Yes/No) | text |
Main Business Description | text |
Service Areas | text |
Location | object |
Additional Info | object |
Established Year | text |
Timezone | choice |
Languages | array |
More Hours | text |
Apple More Hours | text |
Open 24/7 (0/1) | text |
Hours Of Operation | text |
Special Hours | text |
Business Status | text |
Reopen Date | text |
Media | object |
Logo URL | text |
Cover Image URL | text |
GMB Cover URL | text |
Facebook Cover URL | text |
Opt-Out Flags | object |
GMB Logo Opt-Out | boolean |
Facebook Logo Opt-Out | boolean |
GMB Cover Opt-Out | boolean |
Facebook Cover Opt-Out | boolean |
GMB Profile Opt-Out | boolean |
Business Profile Opt-Out | boolean |
COVID Info | object |
Post Description | text |
COVID-19 Support Link | text |
Virtual Care Link | text |
Bing Listing | object |
Primary Category (Bing) | text |
Categories (Bing) | array |
Phone (Bing) | text |
Description (Bing) | text |
7other input fields
Input fields
| Field | Type |
|---|---|
Product IDRequired | choice |
Business Number | text |
Business Numbers | choice |
TitleRequired | text |
Description | text |
Image LinkRequired | text |
Additional Image Links | array |
7other input fields
Output fields
| Field | Type |
|---|---|
Product ID | text |
Code | number |
Message | text |
Data | object |
Error Attributes | array |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Profile Tabs | array |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Tracking IDRequired | text |
Post TextRequired | text |
Social SiteRequired | text |
Sub-Business NumbersRequired | choice |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Tracking IDRequired | text |
Post TextRequired | text |
Social SiteRequired | text |
Sub-Business NumbersRequired | choice |
Schedule Timestamp | number |
Media | array |
1other input field
Input fields
| Field | Type |
|---|---|
Survey IDRequired | choice |
Business ID | text |
Survey Settings | object |
Access Control | object |
Output fields
| Field | Type |
|---|---|
Survey ID | number |
Survey Setting ID | number |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Ticket UpdatesRequired | array |
Input fields
| Field | Type |
|---|---|
Business Number | text |
EmailRequired | text |
Enterprise-Level AccessRequired | text |
Location Numbers Access | choice |
User | object |
User Role | choice |
Notification | object |
Input fields
| Field | Type |
|---|---|
Business Number | text |
Media URLsRequired | array |
Folder ID | number |
Output fields
| Field | Type |
|---|---|
Batch ID | text |
Accepted Count | number |
Input fields
| Field | Type |
|---|---|
Contact ID | text |
First Name | text |
Last Name | text |
Email | text |
Phone | text |
Country Code | choice |
SMS Opt-In | boolean |
7other input fields
Output fields
| Field | Type |
|---|---|
ID | text |
Input fields
| Field | Type |
|---|---|
Contact ID | text |
First Name | text |
Last Name | text |
Email | text |
Phone | text |
Country Code | choice |
SMS Opt-In | boolean |
8other input fields
Output fields
| Field | Type |
|---|---|
ID | text |