Metric widget¶

The metric widget shows a live result of your feedback on any web page: the average grade, the Net Promoter Score, or the customer satisfaction score, for the whole account or for one campaign. It is a small public frame rendered by InstantFeedback, so it always shows the current numbers.

• Three metrics: Average grade (AVG), Net Promoter Score (NPS), and Customer satisfaction (CSAT). NPS and CSAT are offered only when the account has campaigns with that metric.
• Account-wide or per campaign.
• An optional period selector inside the widget, and fixed filters by period, date range, and campaigns.
• Embed as a script snippet or as an iframe. Nothing is stored in InstantFeedback; the whole configuration lives in the embed code.

Before you start¶

• Any member of the account can open the widget pages. For a campaign widget you need access to that campaign.
• The widget is public. Anyone who has the embed code or the frame address can display the metric, so only embed it where the numbers may be seen.

Account-wide widget¶

1. Open Reports and click Widgets in the top-right corner of the overview.

1. Under Widget settings, choose the Metric, the Language of the widget, and the options for that metric.
2. Under Filtering, choose a Period or a date range, and optionally limit the widget to some Campaigns. Click Apply.
3. Check the Preview, then copy the Script embed code or the iframe embed code with Copy to clipboard.

Changing the metric or the period refreshes the page immediately; other changes take effect when you click Apply. The preview and both embed codes are generated from the current settings, and nothing is saved. To change a widget that is already on your website, come back to this page, set the options again, and replace the embed code.

Campaign widget¶

1. Open Campaigns, click the campaign, open the menu in the top-right corner, and choose Widgets.
2. Select the Metric widget tab. For campaigns without a feedback widget it is the only tab.

The settings are the same as for the account-wide widget, with these differences:

• Metric offers the campaign's own metric and Average grade (AVG).
• There is no Scale setting; the campaign's scale is used.
• There is no Campaigns filter.

A campaign widget is a separate embed with its own token, not an override of the account-wide widget. Both can be on the same page.

What visitors see¶

Embed code¶

Both snippets are generated on the Widgets page. The script version renders the widget into a <div>:

<div id="ifb-metric-1"></div>
<script src="https://app.instantfeedback.si/ifbapi.js"></script>
<script>
    ifbapi.metricWidget({
        token: '<token>',
        filters: {
            period: '3m'
        }
    }).render('#ifb-metric-1');
</script>

The iframe version needs no JavaScript:

<iframe id="ifb-metric-frame-1" src="https://app.instantfeedback.si/widgets/metrics/<token>/?period=3m"
        width="100%" height="240" frameborder="0" scrolling="no"></iframe>

The token encodes the account or campaign, the metric, the language, the scale or layout, and whether the period selector is shown. The filters travel separately: as the filters object of ifbapi.metricWidget(), or as query parameters of the frame address. The height in the iframe snippet fits the chosen metric and layout.

Troubleshooting¶