This provides a high-level overview of the flow of API calls to make to manage inventory and route traffice to Survey opportunities.There are two approaches to integrating with the InnovateMR Platform:
This model, or integration approach, exposes an inventory to you and your platform is responsible for matching the respondent to the survey and then routing them accordingly.1 - Get Allocated Surveys
Get Targeting -> Retrieves Survey qualifications / entrance criteria
Get Quotas, -> Retrieves any qualification quotas associated with Survey. (Only needs to be called if Survey isQuota == True)
3 - Match Survey to Respondent
Your platform will match respondents to the right surveys (qualificaitons)
4 - Route Respondent to Survey
Using the Survey Entry Link of the desired Survey, append PID + Qualifications and route respondent..
4.5 - Respondent Pre-Survey Check (Optional, but recommended)
To ensure that the Respondent is likely qualify for the survey, you can make a call to the Respondent Pre-Survey Check endpoint. This will perform several pre-survey checks and help identify if there are any already-known reasons for disqualifications.
This is intended to help improve respondent experience and conversion rate through high-quality clicks.
5 - Respondent Survey Flow
Once the Respondent has been routed to the Survey, the Respondent-Survey Flow takes places with the intent that the Respondent completes the Survey.
6 - Respondent Returns
Once the Respondent has been awarded a status, they will be returned to your platform via the corresponding Redirect Url.
This model provides a simpler integration path which pushes the respondent-survey matchmaking to the InnovateMR platform.1 - Set Respondent Profiling Information
For InnovateMR platform to match surveys to respondents, it needs to know the qualifications of the respondent. To do this, make a call to the Set Panelist Profiling endpoint which will give the needed info for decision making.
2 - Get Surveys for Respondent
Make a call to the Get Surveys For Respondent endpoint will use the known qualifications for the respondent and return a list of available Surveys.
3 - Route Respondent to Survey
Using the Survey Entry Link of the desired Survey, route the respondent directly to the Survey.
4 - Respondent Survey Flow
Once the Respondent has been routed to the Survey, the Respondent-Survey Flow takes places with the intent that the Respondent completes the Survey.
5 - Respondent Returns
Once the Respondent has been awarded a status, they will be returned to your platform via the corresponding Redirect Url.
