Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Track Net Promoter Score and promoter, passive, and detractor share over time.
MCPget_nps_over_time
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
startDate | string | No | 12 months ago when no period is requested | Start date in MM/DD/YYYY format |
endDate | string | No | Today when no period is requested | End date in MM/DD/YYYY format |
reviewSites | list[integer] | No | All sources | Review source IDs, such as 2 for Google, 1 for Yelp, 110 for Facebook, or 100 for Birdeye |
Is our Net Promoter Score improving, and how has the detractor share changed?
| Field | Description |
|---|---|
totalCount | Total responses counted |
avgNpsScore | Account NPS |
promoters | Promoter percentage |
passives | Passive percentage |
detractors | Detractor percentage |
dataPoints | Period-level NPS, counts, percentages, labels, and dates |
groupByType | Time bucket selected by the service |
-100 to 100; a negative score is valid.promoters, passives, and detractors are percentages, not raw counts.get_nps_by_location for location comparisons.