Mobile SpotChecks

Configuring mobile-based SpotChecks can be accomplished in 4 simple steps.

Installation

This involves installing the necessary dependencies to implement the SpotChecks functionality in your application.

Initialization

This involves adding required configurations such as specifying the targetToken, and domain name and inserting the component into all the necessary screens of your application. Below are the required properties to be set when initializing the SpotChecks.

  • userDetails -> The properties here should be the same as the contact properties in SurveySparrow such as uuid, email, firstName, lastName, etc. This will ensure that a contact is being created in SurveySparrow.

    • You can provide either email, uuid, or mobile to act as a unique identifier.

  • domainName -> The domain of your SurveySparrow account. For example, domain.surveysparrow.com.

  • targetToken -> A token that is provided in the code snippet when creating a target.

  • customProperties -> These are the user-defined key-value pairs that can act as additional information for triggering surveys.

  • sparrowLang -> It allows the surveys to be displayed in the specified languages.

    • en -> English

    • hi -> Hindi

    • ml -> Malayalam

    • ta -> Tamil

    • te -> Telugu

  • variables -> These are the global variables that are part of the survey. Make sure to use the API identifier of the global variable, which you will find when you are creating a variable

    • While using variables of type "Date", it is recommended to pass the value as a String in the following format -> "yyyy-mm-dd" or "mm-dd-yyyy"

Screen Track

This allows for specifying the screens in which the surveys should be displayed. It is required to create the screen in the SpotChecks configuration panel and paste the screen name here to track the respective screen. Tracking screens is required even if you choose "All screens" in the Spots section.

Event Track

It is necessary to add custom events while creating a mobile-based target in SpotChecks to display a survey, based on event triggers.

There is also an option to pass custom properties to the event triggers using which you can set conditions in the visitors section of the configure panel.

Note:

  1. Voice Transcriptions within the Text-Based Survey Questions are unavailable for all mobile targets.

  2. Question types namely Photo Capture, Upload, Record Audio, and Signature are not available in the Android Operating System.

Below is the SpotChecks setup guide for various tech stacks of a mobile application.

Last updated