SurveySparrow Android SDK enables you to collect feedback from your mobile app. Embed the Classic, Chat & NPS surveys in your Android application seamlessly with few lines of code.

Mobile SDK share channel is only available from SurveySparrow Premium plan onwards.

1. Fully customizable pre-build Activity to take feedback whenever & wherever you want.
2. Fragment to integrate the feedback experience anywhere in your app.
3. Schedule Surveys to take one-time or recurring feedbacks.

Add it in your root build.gradle at the end of repositories:

allprojects {
  repositories {
    ...
    maven { url 'https://jitpack.io' }
  }
}

Add the following line to your app modules build.gradle file inside dependencies

implementation 'com.github.surveysparrow:surveysparrow-android-sdk:0.4.8'

The SDK need Internet access to fetch survey & submit answers. Add the following permissions to AndroidManifest.xml file

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

Take feedback using our pre-build Activity and get the response after submission by overriding the calling Activity's onActivityResult method.

Create SDK token by from the share page of your survey in the SurveySparrow web app and use that token to create the SsSurvey Object.

SsSurvey survey = new SsSurvey("your-company-domain", "sdk-token");

Create a SurveySparrow object to configure and start the feedback Activity.

SurveySparrow surveySparrow = new SurveySparrow(this, survey)
                .setActivityTheme(R.style.AppTheme)
                .setAppBarTitle(R.string.app_name)
                .enableBackButton(true)
                .setWaitTime(2000)
                .setValidateSurveyListener(this); // add this if you are using OnSsValidateSurveyEventListener in your activity

surveySparrow.startSurveyForResult(SURVEY_REQUEST_CODE);

Override the onActivityResult to handle the response.

@Override
protected void onActivityResult(int requestCode, int resultCode, @Nullable
  Intent data) {
  super.onActivityResult(requestCode, resultCode, data);
  if (requestCode == SURVEY_REQUEST_CODE) {
    if (resultCode == RESULT_OK) {
      // Convert the response to JSON.
      JSONObject responses = SurveySparrow.toJSON(data.getData().toString());

      // Add your logic here...
    } else {
      // The activity closed before completing the survey.
    }
  }
}

Override the onSsValidateSurvey to handle the survey validation.

@Override
public void onSsValidateSurvey(JSONObject s) {
    Log.v(LOG_TAG, "survey validation json" + s.toString());
}

Embed the feedback experience to your Activity using the SsSurveyFragment. Then you can implement the OnSsResponseEventListener interface to handle response after submission.

Implement OnSsValidateSurveyEventListener interface to handle validation of survey

SsSurvey survey = new SsSurvey("your-company-domain", "sdk-token");

For versions below 0.4.0

SsSurveyFragment surveyFragment = new SsSurveyFragment(survey);

For other versions

SsSurveyFragment surveyFragment = new SsSurveyFragment();
surveyFragment.setValidateSurveyListener(this); // add this if you are using OnSsValidateSurveyEventListener in your activity
surveyFragment.setSurvey(survey);

FragmentManager fragmentManager = this.getSupportFragmentManager();
FragmentTransaction fragmentTransaction = fragmentManager.beginTransaction();
fragmentTransaction.add(R.id.surveyContainer, surveyFragment);
fragmentTransaction.commit();

Implement the OnSsResponseEventListener interface in your Activity and override the onSsResponseEvent method to get and handle the response.

public class YourActivity extends AppCompatActivity implements OnSsResponseEventListener {
  // Your code...
  @Override
    public void onSsResponseEvent(JSONObject response) {
        // Handle response here
    }
  // Your Code...
}

Override the onSsValidateSurvey to handle the survey validation.

@Override
public void onSsValidateSurvey(JSONObject s) {
    Log.v(LOG_TAG, "survey validation json" + s.toString());
}

Ask the user to take a feedback survey when they open your app/Activity/page after a period of time.

SsSurvey survey = new SsSurvey("your-company-domain", "sdk-token");

surveySparrow = new SurveySparrow(this, survey)
        .setActivityTheme(R.style.AppTheme)
        .setAppBarTitle(R.string.app_name)
        .enableBackButton(true)
        .setWaitTime(2000)
        .setValidateSurveyListener(this); // add this if you are using OnSsValidateSurveyEventListener in your activity

        // Schedule specific config
        .setStartAfter(TimeUnit.DAYS.toMillis(3L))
        .setRepeatInterval(TimeUnit.DAYS.toMillis(5L))
        .setRepeatType(SurveySparrow.REPEAT_TYPE_CONSTANT)
        .setFeedbackType(SurveySparrow.SINGLE_FEEDBACK);

surveySparrow.scheduleSurvey(SURVEY_SCHEDULE_REQUEST_CODE);

Handle response the same way as Take feedback using Activity

Handle survey validation the same way as Handle survey validation

You can clear a schedule by calling the surveySparrow.clearSchedule() method.

We will show a customized prompt to take a feedback survey whenever the scheduleSurvey method called after the setStartAfter time and if the user declines to take the survey we will show the prompt after the setRepeatIntervalTime.

Example use case: Add the above code to onStart method of your launcher Activity to ask the user to take a feedback survey 3 days after the user starts using your app, and if the user declines to take the survey we will continue to prompt at an interval of 5 days. If the user takes and complete the survey once we will not ask again.

*You can only create one schedule per token. Create multiple tokens if you want to create multiple schedules for same survey.

Survey type can be changed to NPS using setSurveyType(SurveySparrow.NPS) on an SsSurvey instance. You can also pass email as a custom param.

CustomParam : To hold custom params.

Constructor - CustomParam(CharSequence name, CharSequence value)

SsSurvey(CharSequence domain, CharSequence surveyToken) : Create SsSurvey with domain & token

SsSurvey(CharSequence domain, CharSequence surveyToken, CustomParam[] customParams) : Create SsSurvey with domain, token & custom params.

SurveySparrow(Activity context, SsSurvey survey) : Create SurveySparrow object with Activity context & SsSurvey

Implement OnSsResponseEventListener in your Activity to listen for survey response event.

Please submit bugs/issues through GitHub issues we will try to fix it ASAP.