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

Targeting Surveys & Announcements

Detailed here is how you can have your surveys target specific users as well as some related APIs.

You can define criteria that your users have to meet in order for your surveys to appear in their app. This can be done through both automatic and manual targeting. The available targeting types vary based on the survey or announcement template you're using.

Auto Targeting

After choosing the survey type you want to create, you can target specific audiences using custom conditions.

When you select Auto Targeting, you can define criteria for who should receive the survey. Your users matching the conditions you set will automatically see the survey. In addition to default attributes like App Version, OS, Email, Sessions Count, Last Seen, Country, etc., you can set conditions for custom user attributes or user events that you have created. Multiple different criteria of any type can be added.

You can specify the who, when, and frequency of the survey.

  • Who: this is used to automatically target specific users. You can target users with specific attributes or users that have done specific events.
  • When: specify when the survey should show to your users. By default, this is set to 10 seconds after the application launches. This can be set so that the survey shows the moment a specific event occurs.
  • Frequency: the amount of times the user sees the survey within a certain period. By default, this is once every 30 days. The number of days can be edited and you can set it so that the survey only appears once and never again afterward.

This is the audience targeting step of the survey creation flow in your dashboard, with Auto Targeting selected.

Depending on the template you use, different options will be available to use for automatic targeting.

📘

Targeting using App Version

Starting from version 8.5.0, the accepted app versions can be any of the ones with the following formats:

  • x.y.z (ex: 1.4.2)
  • x.y.z.w (ex: 1.4.2.7)
  • x.y.z[any string] (ex: 1.4.2april2016) this format can only be used with equals to and can't be set to greater or less than

Controlling Auto Targeting

You can have auto targeting surveys shown automatically at the start of a user's session or show it manually.

Showing Automatically

By default, a survey will automatically be presented to users who meet your conditions in their first session after you publish the survey within 10 seconds of opening your app. If you have multiple surveys running and a user meets the conditions for more than one survey, they will be shown each survey one by one.

Showing Manually

You can also customize when you want to show your auto-targeting surveys. To do this, first, disable automatic showing using the following API.

//iOS
IBGSurveys.AutoShowingEnabled = false;

//Android
Surveys.SetAutoShowingEnabled(false);

Then present surveys manually at an appropriate time.

//iOS
IBGSurveys.ShowSurveyIfAvailable();

//Android
Surveys.ShowSurveyIfAvailable();

Targeting Through CSV

If you'd like to target a list of specific user emails, this is now possible by uploading a CSV in the targeting step. Each email should be in a separate row with no more than 100K entries. The file should also be less than 5MB in size. Once the file is uploaded, the dashboard will take care of the rest!

Manual Targeting Surveys

After choosing the survey type, you can target different audience using manual targeting. You can manually control when a manual targeting survey should show up. Each created survey has a unique token that you can refer to in your code as explained in the following section. Once you publish a manual targeting survey, you can use the unique token that was generated in your application.

Controlling the Manual Targeting Surveys

Sometimes, it's you'd like to show only specific users surveys, like users who opt-in to take these surveys. For these users, it's a better idea to show a manually targeted survey. You can use the following API to show a survey with a specific token. Manual targeting surveys can be displayed to the user any number of times.

//iOS
IBGSurveys.ShowSurveyWithToken("TOKEN");

//Android
Surveys.ShowSurvey("TOKEN");

You can also check if the current user has responded to a specific survey before or not through the following API.

//iOS
bool hasResponded = IBGSurveys.HasRespondedToSurveyWithToken("TOKEN");

//Android
bool hasResponded = Surveys.HasRespondToSurvey("TOKEN");

The above API is particularly useful since you can manually show a survey multiple times to the same user. More information can be found here regarding reshowing already shown surveys.

Updated 6 months ago


What's Next

Your survey is now targeting specific users so check out how to customize some behavioral elements of the survey.

Customizing Survey Behavior

Targeting Surveys & Announcements


Detailed here is how you can have your surveys target specific users as well as some related APIs.

Suggested Edits are limited on API Reference Pages

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