Who can access the set up ?
Roles | Access |
👑 Admins | Full access |
🛠️ Editors | No access |
👀 Viewers | No access |
🔒 Restricted Viewers | No access |
What are the different widget mode ?
How to display the widget ?
Step 1: Load the library
Include in your site’s header the display widget script:
<script async defer src="https://display-widget.feedier.com/widget.js?api_key={PUBLIC FEEDIER API KEY}"></script> To find your API key :
Feedier → Advanced Settings -> Public API Key
Step 2: Add the data element in your page
Both widgets use a <div> structure with parameters passed as data elements.
Example:
<div data-feedier-widget data-layout="compact" data-primary-color="#cc0d2b" data-kpi='ratings("survey.id", "=", "123")' data-score-max="5" ></div>
What are the shared parameters for both widget mode ?
Parameter | Required | Description |
| ✅ | Used for the library to initialise the widget. |
| ✅ |
|
| ✅ | The max of the scale, for example |
| ✅ | The KPI being rendered using Feedier’s KPI language: KPI Documentation Some examples: sentiment("topic.name", "=", "Packaging"), ratings() nps(), satisfaction(), etc. |
| ❌ | The HEX color code of the widget |
| ❌ | The minimum number of feedback required to display the widget. If set to |
| ❌ | The minimum KPI score required to display the widget. If set to |
| ❌ | An optional FQL to filter the feedbacks used on the widget. This supports ALL filters on the FQL module in Feedier, see: Use Filters (FQL) in the Feedier API |
| ❌ | Either |
| ❌ | Used to override any string displayed:
data-locales='{ "fr": { "labels": { "title": "Avis clients" }, "full": { "loadMore": "Voir plus" } }, "*": { "full": { "sort": { "label": "Ordonner les retours" } } } }' |
What are the Specific parameters for compact widget mode ?
Parameter | Required | Description |
| ❌ | CSS target used to redirect the user clicks on the widget to another part of the page. For example to the text feedbacks on a second widget loaded on the page. See example below. |
<div data-feedier-widget data-layout="compact" data-primary-color="#cc0d2b" data-kpi='ratings("survey.id", "=", "123")' data-threshold="3.5" data-score-max="5" data-min-count="10" data-target="#feedier-reviews" data-locale="en" ></div> .... <div id="feedier-reviews" data-feedier-widget data-layout="full" ...
What are the Specific parameters for full widget mode ?
Parameter | Required | Description |
| ❌ | HTML content that is displayed under the title. It can contain links, content, etc. |
Every card on the full widget has 3 elements:
An attribute (such as name, product, etc.)
A score
A verbatim
All of these are optionals.
Parameter | Required | Description |
| ❌ | Identifies the card’s title. It must be an existing Feedier attributes (see Attributes page in Feedier). |
| ❌ | The Feedback item ID in Feedier used to display the score in the card. |
| ❌ | The Feedback item ID in Feedier used to display the verbatim in the card. |
Example,
<div id="feedier-reviews" data-feedier-widget data-description='Description example here. <a href="test.com"> Link</a>' data-layout="full" data-primary-color="#cc0d2b" data-score-max="5" data-threshold="3.5" data-min-count="200" data-locale="en" data-kpi='ratings("survey.id", "=", "123")' data-heading-attribute-name="first_name" data-score-feedback-item-id="456" data-verbatims-feedback-item-id="789" ></div>
