1. Home
  2. Developers
  3. Json Endpoint for GatherUp

Json Endpoint for GatherUp

The following JSON endpoint is an alternative to using the GatherUp API:
https://app.GatherUp.com/api/doc/feedbacks/get
https://app.GatherUp.com/api/doc/feedbacks/responses/get

Feedback Data

JSON Endpoint for real time feedback and response feed using the Business ID: https://GatherUp.com/reviews/BUSINESS_ID.0.json

– Please replace BUSINESS_ID with your actual business id.
– Example: https://app.GatherUp.com/reviews/1704.0.json

To find the business ID see here.

Pagination

The output per page is limited to 5 feedbacks to provide maximum speed and performance.

Add ?page=PAGENUMBER to endpoint URL to integrate with new or existing pagination on your site.

?page=1
?page=2
?page=3

Example:
Page 1) https://app.GatherUp.com/reviews/1704.0.json?page=1
Page 2) https://app.GatherUp.com/reviews/1704.0.json?page=2
Page 3) https://app.GatherUp.com/reviews/1704.0.json?page=3

Optional “perPage” Parameter:

Add &perPage=__ to the endpoint URL to specify the amount of reviews per page.

If the parameter is not set 10 reviews will show by default.

If the parameter is set to 100, but the location has only 18 reviews nothing will break – it will simply only show 18 reviews.

  • default value 5,
  • min value: 1,
  • max value: 100

Example:
Page 1) https://app.GatherUp.com/reviews/1704.0.json?page=1&perPage=20
Page 2) https://app.GatherUp.com/reviews/1704.0.json?page=1&perPage=60
Page 3) https://app.GatherUp.com/reviews/1704.0.json?page=1&perPage=100

Optional “onlyApproved” Parameter:

Add &onlyApproved=__ to the endpoint URL to specify the review calculation to be used.

If the parameter is not set only approved reviews will be calculated.

If the parameter is set to 0, all reviews will be included.

  • 0 – Shows all reviews
  • 1 – Shows only approved reviews (default)

Example:
https://app.gatherup.com/reviews/1704.0.json
https://app.gatherup.com/reviews/1704.0.json?onlyApproved=1
https://app.gatherup.com/reviews/1704.0.json?onlyApproved=0

Advanced Filtering

The output can be filtered using “Tags”. See here for how to tag your feedback.

http://app.GatherUp.com/reviews/BUSINESS_ID.TAG.json

Example using three tags for your feedback such as: Boat, RV, Car

Tag 1) https://app.GatherUp.com/reviews/1704.Boat.json
Tag 2) https://app.GatherUp.com/reviews/1704.RV.json
Tag 3) https://app.GatherUp.com/reviews/1704.Car.json

White-label Product Users

White-label customers can replace the URL (http://apps.GatherUp.com) with their own URL.

White-label customers using the ‘Custom Field’ option in GatherUp can also use their custom field prefix and custom field ID instead of the Business ID.

Ping us at support@GatherUp.com for questions you may have!

Updated on October 25, 2019

Was this article helpful?

Related Articles