Welcome to Instabug's Documentation!
Here you'll find a comprehensive technical guide
to help you start working with the Instabug SDK efficiently.

Get Started

Creating Surveys & Announcements - Localization

This page explains the different types of Surveys and Announcements you can create.

You can create surveys, a tool to collect feedback from your users, and announcements, a method to relay information to your users. There are five different types of surveys and announcements that you can create:

  • Custom Survey: create a set of customized questions using different question types
  • NPS Survey: find out whether your users would promote your application or not, then have them rate your application
  • App Rating: ask your users if they like your app. If they answer yes, they'll be prompted to rate your application
  • Version Update: let your users know that there is a new version and prompt them to update it
  • What's New: update your users with what's new to increase the adoption rate of new features
This is the first step of the survey creation flow in your dashboard.

This is the first step of the survey creation flow in your dashboard.

Surveys

You can choose between three types of surveys when creating a new one: Custom Survey, NPS Survey, and App Rating.

Custom Survey

Create your own custom surveys with any number of questions displayed to your user one by one, sequentially. You can select between three types of answers:

  • Text Field: The user must answer the question by typing their response in a text field.
  • Multiple Choice: The user must answer the question by choosing one of any number of answers you have defined in your dashboard.
  • Stars: The user must answer the question with one to five stars.

This type of survey can use both manual and automatic targeting.

From this screen in your dashboard, you can customize the content of the questions and answers in a Custom Survey.

From this screen in your dashboard, you can customize the content of the questions and answers in a Custom Survey.

NPS Survey

The default first question in an NPS Survey is "How likely are you to recommend <Your App Name> to a friend or colleague?" The user must reply on a scale of 1-10, least to most likely.

Depending on the rating given by the user, they will be shown one of three possible follow-up questions:

  • User rating is 9 or 10 (Promoter): The user will be asked for feedback about how to improve the app. You will also have the option to allow the users to rate the application while creating the survey. A link is then generated to your app on the App Store. The user will be asked to rate your app. If they accept, they will be redirected to the App Store link. If your app is in beta, or if your app is not available on the App Store, the user will instead be asked to submit their survey.
  • User rating is 7 or 8 (Passive): The user will be asked for feedback about how to improve the app. You will also have the option to allow the users to rate the application while creating the survey.
  • User rating is less than 9 (Detractor): The user will be asked for feedback about how to improve the app.

This type of survey can use both manual and automatic targeting.

From your dashboard, you can customize the text of any question in an NPS Survey.

From this screen in your dashboard, you can customize the content of the questions asked in an NPS Survey.

From this screen in your dashboard, you can customize the content of the questions asked in an NPS Survey.

App Rating

This template is used to identify happy users and ask them to rate your app.

First, you're users will see an alert, native to the OS, which asks if they are satisfied with the application.

  • If the user answers yes, they will be asked to rate the application on the App Store in another alert automatically. If the application is in beta mode, the user will not be asked to rate on the App Store.
  • If the user answers no, they will be asked how the application can do better in a survey format similar to the one in the custom survey section.

This type of survey can use both manual and automatic targeting.

You can set the frequency for how often this message shows. By default, it is set to every 30 days.

Changing the Alert Text

During the creation process, you can edit any of the text that will be in the alerts shown to the users.

From this screen in your dashboard, you can customize the content of the questions and CTAs in an App Rating Survey.

From this screen in your dashboard, you can customize the content of the questions and CTAs in an App Rating Survey.

Announcements

There are two different types of announcements that you can send out. The different types are Version Update and What's New.

Version Update

Prompt users to update to the latest version of your application using this feature.

This feature lets you send native alerts to your users to update their application. The alert can be set to either:

  • Mandatory: the alert cannot be dismissed and has a button that leads to the store
  • Optional: the alert will have two buttons, one to dismiss the alert and one to lead to the store for the user to update

This type of announcement can only use automatic targeting.

It can also be set to either show every session or every once every 7 days. By default, it appears after 10 seconds of the session (this is configurable). You can also specify the version for which this alert will show.

From this screen in your dashboard, you can customize the Update Type and the content of the questions and CTAs in a Version Update Announcement.

From this screen in your dashboard, you can customize the Update Type and the content of the questions and CTAs in a Version Update Announcement.

What's New

Alert users about new features and the latest improvements to your application using this announcement.

You can create a list of new features to show your users. Each entry in the list contains a:

  • Title: name of the feature
  • Description: a short summary of what the feature is
  • Icon (Optional): a small icon to be displayed next to each feature on the list

This type of announcement can only use automatic targeting.

It only appears to the users updating to the version specified and not the new users who install the app on this version. By default, it appears only once on the first app launch to users on a specified version.

From this screen in your dashboard, you can customize the features name, description, and icon in a What's New Announcement.

From this screen in your dashboard, you can customize the features name, description, and icon in a What's New Announcement.

Survey Localization

You can display your surveys and announcements to your users in their language. To do this, you only need to add the locale when creating the survey, then add the questions in that language.

Editing Survey Locales

There are some rules that should be adhered to when adding and editing locales and languages for surveys and announcements.

Default Language

Every survey and announcement you create must have a default language. This default language is used when no locale is set and you don't support the device's current locale, so make sure you set the right default language. By default, the default language is set to English.

For each locale you add, a new tab will be added in the dashboard from where you can modify the text that will be displayed for that locale. Other changes to the survey, like adding or removing questions, can only be done from the default locale tab.

Determining Shown Locale

The SDK determines which survey language is shown based on a few priorities. If you use the set locale API, this locale will take precedence over the device locale so the survey will be shown in the locale you set through the API. Otherwise, surveys will be displayed in the language that matches the device locale. In case you don't support this locale, the survey will use the default language.

To summarize, in order of priority:
1 - Locale set through API (as shown here)
2 - The device locale
3 - Default locale set through the dashboard (if device locale isn't supported)

Supported Locales

Currently, most locales supported by the SDK are supported in the survey localization, with more locales to be added soon. Below is the list for supported locales.

English en
- Arabic ar
- Czech cs
- Danish da
- German de
- Spanish es
- French fr
- Italian it
- Japanese ja
- Korean ko
- Dutch nl
- Norwegian (no, nb) --> nb-NO
- Polish pl
- Portuguese Brazil pt-BR
- Portuguese Portugal pt-PT
- Russian ru
- Slovak sk
- Swedish sv
- Turkish tr
- Chinese Simplified (zh-hans, zh-CN) --> zh-CN
- Chinese Traditional (zh-TW,  zh-hant-TW, zh-Hant) --> zh-TW

Backwards Compatibility

Multiple locale surveys will appear starting from version 8.3. If you're targeting older SDKs, only the default survey locale will be shown. All surveys created before version 8.3 will continue to work with only a single locale.

Creating Surveys & Announcements - Localization


This page explains the different types of Surveys and Announcements you can create.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.