Get a pre-formatted widget or badge html code with schema.org structure and seo-friendly content.
Learn about the difference between Widget and Badge here.
Each widget comes with a built-in php snippet that will load the feedback and schema markup directly into your website. Currently this method only works with PHP-based websites. HTML only sites will show the feedbacks received, but no Schema Markup will be added.
To create an aggregated widget or badge please include more than one business ID as parameter. A typical scenario would be a multi location business. You could show an aggregated badge on the homepage showing an overall count and rating from all business locations. And have individual landing pages for each location which shows the testimonials widget for the specific location only.
If you would like to do your own styling and markup you could consider the /feedbacks/get API call.
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
| businessId | integer | yes | 376 | Business id (or multiple comma-separated ids.) |
| clientId | string(40) | yes | 04f78...9f9f3 | Client id is a unique user identifier provided by GatherUp. |
| fullVersion | integer(0,1) | no | 0 | By default it is set to 0 which does not include CSS. Full version (1) contains the entire widget code, SEO, Schema and CSS. |
| hash | string(64) | yes | bd13a40...303f3c5 | Hash is a digital request signature. Learn how to generate hash here. |
| includeSchemaOrg | integer(0,1) | no | 1 | By default schema.org tags are included. |
| widgetType | string(widget|badge) | no | 1 | By default it returns widget. |
{
"businessId": 376,
"clientId": "04f78076fbfc66940169d2199af7c6698019f9f3",
"hash": "5122a609fe4b55cad783546fe0b2f58031df3c26b228975ec7cda5d3c011a7ff"
}
{
"widgetHTML": "<div id=\"e2wget5section\" ... <\/div>",
"errorCode": 0,
"errorMessage": "Success"
}
| errorCode | errorMessage |
|---|---|
| -1 | Unknown error |
| 1 | Invalid hash sign |
| 2 | Invalid clientId |
| 3 | Server error - please contact support |
| 5 | This user cannot manage selected business |
| 13 | Unable to generate widget for specified businessId |