Correct reporting tool docs based on live testing - #40
Open
Nitesh-BE wants to merge 2 commits into
Open
Conversation
Tested all 15 report tools against a live account and fixed
discrepancies between the documented behavior and the actual API:
- get_review_and_rating_by_location's example/response fields
described the wrong shape entirely (flat array vs. the real
paginated object with dataPoints/lowestRated/highestRated), and it
can 500 when called with a relative date window and no
businessNumbers scope.
- get_business_dashboard_report's visitors field is
{reviewSite, website, total}, not a flat count.
- get_nps_by_location's size parameter is not honored by the API.
- Several "over time"/"by location" tools default to full account
history when no date range is passed, not the last N months/days
implied by their docs (get_nps_over_time, get_nps_by_location,
get_avg_response_time_over_time/by_location,
get_review_response_rate_over_time/by_location).
- compare is omitted entirely (not zeroed) when comparison dates
aren't supplied, on tools that support period comparison.
- get_review_count_by_source's sourceAlias values are lowercase
machine identifiers, not display names.
- get_usage_report's example showed sent-channel percent as 0
instead of the correct self-referential 100.
- Documented null-handling gaps in get_review_count_by_rating_by_employee
(employee/lastName) and get_visitor_count (businessId).
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
The example response and field table were missing several top-level fields that are actually present in the live response (businessNumber, id, name, isModifiable, heirarchyGroups, and emailDetails inside emailSentInfo). Also documented that pc means a different shape in emailOpenInfo (number) vs. emailClickInfo (object), confirmed while testing.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Tested all 15 report tools against a live account and fixed discrepancies between the documented behavior and the actual API: