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

JSON Endpoint for GatherUp

The following JSON endpoints are alternatives to using the GatherUp API /feedbacks/get or /responses/get.

JSON Endpoint URL

The JSON Endpoint URL for real-time feedback and response feed using the Business ID is:

https://app.GatherUp.com/reviews/BUSINESS_ID.0.json

To use, replace BUSINESS_ID with your actual business id as shown in this example:

https://app.GatherUp.com/reviews/1704.0.json

SEE ALSO: Business ID

Pagination

The output per page is limited to 5 feedbacks to provide maximum speed and performance. Add the following to the Endpoint URL to integrate with new or existing pagination on your site.

?page=PAGENUMBER

To use, replace PAGENUMBER as shown in this example:

https://app.GatherUp.com/reviews/1704.0.json?page=1

“perPage” Parameter:

An optional parameter, “perPage” specifies the number of reviews per page when added to the Endpoint URL + Pagination:

?&perPage=#

The min. value is 1 and the max. value is 100. If the parameter is not set, 5 reviews will show by default. If the parameter is set to 100 but the location has only 18 reviews, nothing will break, it will show only 18 reviews.

To use, replace # as shown in this example:

https://app.GatherUp.com/reviews/1704.0.json?page=1&perPage=60

“onlyApproved” Parameter

An optional parameter, “onlyApproved” specifies the review calculation to be used when added to the Endpoint URL:

?&onlyApproved=1 (default, shows only approved reviews)
?&onlyApproved=0 (shows all reviews)

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

To use, add a parameter to the Endpoint URL as shown in this example:

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

Advanced Filtering

The data available via the JSON Endpoint URL can be filtered using Tags by adding the following to the URL:

?filterTags=_____

To use, replace _____ with a Tag used in your GatherUp account as shown in this example:

https://app.GatherUp.com/reviews/1704.0.json?filterTags=service
https://app.GatherUp.com/reviews/1704.0.json?filterTags=cold%20food

SEE ALSO: Tags

White-label JSON Endpoint URL

White-label customers can replace http://app.GatherUp.com in the JSON Endpoint URL with their own URL as shown in this example:

https://reviewability.com/reviews/1704.0.json

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.

Updated on December 5, 2019

Was this article helpful?

Related Articles