1. Supplier API
  • Supplier API – FAQ
  • Supplier API
    • Onboarding Process
    • Mapping
    • Survey Inventory Management
    • Respondent-Survey Flow
    • Statuses, Term Reasons & Categories
    • Onboarding Checklist
    • API Call Flow
    • Complete Validation Notifications
    • Frequently Asked Questions (FAQ)
    • Lookup Question Library
      GET
    • Set Global redirect URLs and Pixels for supplier’s
      PUT
    • Delete Global redirect URLs and Pixels for supplier’s account
      DELETE
    • Core Metadata Fields
      GET
    • Get Question Categories
      GET
    • Get Allocated Surveys (all live surveys)
      GET
    • Get Allocated Surveys By Id
      GET
    • Get Allocated Surveys By Date (live surveys only)
      GET
    • Get Allocated Surveys With Pagination (live surveys only)
      GET
    • Get Redirect Method for Survey
      GET
    • Set Redirect Method for Survey
      PUT
    • Delete Redirect Method for Survey
      DELETE
    • Get Closed Survey List (allocated to supplier only)
      GET
    • Get Survey Transactions data
      GET
    • Get Survey Transactions data By Date Range
      GET
    • Survey Allow for Unique IP
      POST
    • Allow Unique PID & IP
      POST
    • Get Panellist Profiling
      GET
    • Survey Availability Endpoint
      GET
    • Get Survey Stats data By Date Range
      GET
    • Get Questions By Category
      GET
    • Answer Lookup
      GET
    • Get Survey Transactions data By PID and survey number
      GET
    • Get PIDs for re-contact surveys (studies)
      GET
    • Get survey stats
      GET
    • Set Panellist Profiling
      POST
    • update Panellist Profiling
      PUT
    • get surveys for respondent
      POST
    • Respondent Pre Survey Check
      POST
    • Single Term Reason Category Code
      GET
    • term reason category
      GET
    • Get Allocated High Priority Surveys(All Live Surveys)
      GET
    • Get Survey Targeting
      GET
    • Get Quota for Survey
      GET
  • Buyer API - FAQ
  • Buyer API
    • Create Job
    • Update Job
    • Get Job Details
    • Update Job Status
    • Get Job List By Status
    • Create Group
    • Update Group
    • Get Group Details
    • Update Group Status
    • Add Target to group
    • Update Target to group
    • Remove Target Question
    • Add Quota to Group
    • Update Group Quota
    • Get Group Quotas
    • Get Group Feasibility
    • Feasibility (Find estimates)
    • Questions Library
    • Get Job Stats
    • Get Group Stats
    • Get Group Quota Stats
  • Postbacks/Redirects
    • Redirect URL
    • PostBack URL
    • Hashing Mechanism
  • HTTP Status Codes
  • Text Analyzer API - FAQ
  • Text Analyzer API
    • API Details
  1. Supplier API

Statuses, Term Reasons & Categories

Each survey transaction (attempt) by a respondent results in the rendering of a status which indicates the result of the attempt.

Statuses#

Here's a summary but each of these are discussed in detail below.
StatusDescriptionID
CompleteRevenue Earned1
FailedTermination in Client Survey2
Over QuotaQuota was met / Quota Full in Client Survey3
Quality TerminationTermination in Client Survey due to Quality4
Pre-Survey TerminationTerminated due to Qualifications before Client Survey5
Pre-Survey Over QuotaQuota was met / Quota Full on IMR Platform7
Pre-Survey Quality TerminationTerminated due to Quality before Client Survey8
Pre-Survey DNCAbandoned before routing to Client Survey0
Start Survey DNAbandoned while in Client Survey6
These statuses are also availble to be programmatically ingested through our Core Metadata API Endpoint.

Term Reasons & Categories#

For survey transactions that do not end up in a Complete, our platform will provide a Term Reason. This value contains the specific reason the respondent was not able to record a complete.
To aid in understanding and remendiation of these Terminations, we have grouped similar Term Reasons into Term Reason Categories.
Below you will find each of the Term Reason Categroies and associated information.

PreSurveyTerminations (PST)#

The Pre-Survey Termination (PST) survey transaction status is rendered when the respondent was not able to participate in the client-survey due to not satisfy targeting information, incorrect device type, and/or non-quality related reasons.
The numerical/integer ID for this Status is: 5
The respondent in this case was not routed to the client survey.

Term Reason Categories#

Qualifications#

Description: Respondent did not pass the specific targeting question for the survey
Remediation: Check mapping of related question and answers between the two platforms.

DeviceType#

Description: Respondent attempted to participate on a survey using a device that was not supported.
Remediation: Check the mapping and honoring of the device type value set a the survey level.

QuotaFull#

Description: Respondent was not able to participate due to related quota being already met.
Remediation: Check the mapping and honoring of quotas setup at the survey level.

PII#

Description: Respondent is not able to participate due to a PII related matter. Pleaes check the specific Term Reason for more details.
Remediation: Discuss with InnovateMR Team account settings to show/hide surveys that utilize PII information.

CountryMismatch#

Description: The Respondent country did not match to the country of the Survey
Remediation: Ensure the respondent is taking a survey from the country that is specified by the survey metadata.

Recontact#

Description: Respondent is unable to participate in recontact survey either from being not being included in the recontact list or has been exlcuded.
Remediation: Check the integration with the recontact API endpoints. Reach out to InnovateMR team if you have any questions.

OpportunityNotAvailable#

Description: Respondent unable to participate due to the survey no longer being available. This is typically due to latency/staleness between when your survey inventory is ingested and when the respondent attempts to participate.
Remediation: Check how the Survey Inventory is being ingested and updated. Our recommendation is to ingest the inventory every 1-2 minutes.
Also, if a survey was previously available but no longer being returned in the Get Allocated Surveys response, it should be treated as no longer available. The inference to be made here is that the survey is likely paused.
To check if a survey is closed, please integrate with and consult the Closed Survey API Endpoints.

PreSurveyOverQuota (PSOQ)#

The Pre-Survey Over Quota (PSOQ) survey transaction status is rendered when the respondent was not able to participate in the client-survey due to their corresponding quota already being met.
The numerical/integer ID for this Status is: 7
The respondent in this case was not routed to the client survey.

OpportunityFull#

Description:
Remediation:

PreSurveyQualityTerminations (PSQT)#

The Pre-Survey Quality Termination (PSQT) survey transaction status is rendered when the respondent was not able to participate in the client-survey due to a quality related reason.
The numerical/integer ID for this Status is: 8
The respondent in this case was not routed to the client survey.

DuplicatedToken#

Description: Respondent with same token/fingerprint has already participated on this survey OR there is a Survey Exclusion not being honored.
Remediation:
The remedy for this situation is to adjust/ensure your platform interprets the “duplicateCheckLevel” property on the Survey object. Here’s a summary of the required logic.
When duplicateCheckLevel is set to Job Level it signals that any respondent will be terminated with a term reason of “Duplicated to Token ...” who participated on a survey associated with the Job specified in the JobId property and recorded one of the statuses specified in the statuses property. The duplicateSurveyIds property can be ignored in this case.
When duplicateCheckLevel is set to Multi Surveys it signals that any respondent will be terminated with a term reason of “Duplicated to Token ...” who participated on the Surveys specified in the duplicateSurveyIds property and recorded one of the statuses specified in the statuses property.
The example below is for a Japanese survey but the same approach applies regardless of country.
in3.png

ThreatScore#

Description: Device-level quality/fraud score for respondent did not meet threshold for study.
Remediation:

URLManipulation#

Description: Respondent attempted to manipulate the survey experience
Remediation:

RespondentBehavior#

Description: Respondent is displaying behavior that has been identified as likely fraudulent. This can include behaviours like taking too many surveys in rapid succession, speeding through a survey, tampering with device-level fraud checks, etc.
Remediation: Review respondent behavior and determine if they should be blocked due to susupicious behavior. Contact InnovateMR team for further discussion.

FingerprintingError#

Description: This happens when the InnvoateMR platform is having issues communicating with the device-level fraud service.
Remediation: No action needed unless happening in large volumens; otherwise, contact InnovateMR team.

UniqueIP#

Description: Respondent with same IP address has already participated on this survey
Remediation: Incorporate the usage of our Check IP API endpoint into your respondent-to-survey flow.

UniquePID#

Description: Respondent with same PID has already participated on this survey
Remediation: Incorporate the usage of our Check PID API endpoint into your respondent-to-survey flow.

GEOIP#

Description: The Respondent IP address did not resolve to the country of the Survey
Remediation: Ensure that the country that the respondent is participating from matches the country of the survey.

RedHerring#

Description: Respondent did not pass the Red Herring question for the survey
Remediation: Review respondent behavior and determine if they should be blocked due to susupicious behavior. Contact InnovateMR team for further discussion.

DuplicateMultiGroup#

Description: Respondent with token/fingerprint has participated on deduped survey
Remediation: Review integration of survey metadata: duplicateSurveyIds, duplicateCheckLevel, and statuses to ensure that respondents are not being routed to surveys they are excluded from participating on.

Recaptcha#

Description: Respondent failed the recaptcha check when attempting to participate in the survey.
Remediation: Review respondent behavior and determine if they should be blocked due to susupicious behavior. Contact InnovateMR team for further discussion.****

OpenEndValidation#

Description: The quality of a response to an open end quality question did not meet the standard.
Remediation: Review respondent behavior and determine if they should be blocked due to susupicious behavior. Contact InnovateMR team for further discussion.

Failed#

The Failed survey transaction status is rendered when the respondent was routed to the client survey and later terminated.
The numerical/integer ID for this Status is: 2
Also known as Terminated
The respondent in this case was routed to the client survey.

ClientTerm#

Description: Generic termination from client survey experience.
Remediation: No action needed unless happening in large volumens; otherwise, contact InnovateMR team.

OverQuota#

The Over Quota (OQ) survey transaction status is rendered when the respondent was routed to the client survey and later terminated due to qualifying for a client-side quota that was already met.
The numerical/integer ID for this Status is: 3
Also known as Quota Full.
The respondent in this case was routed to the client survey.

ClientQuotaFull#

Description: Respondent was terminated in the client survey due to qualifying quota already being met. This happens when Clients have in-survey quotas that were not made visible in the IMR platform.
Remediation: No further action needed unless happening in large volumens; otherwise, contact InnovateMR team.

QualityTerm#

The Quality Term (QT) survey transaction status is rendered when the respondent was routed to the client survey and later terminated due to being flagged as high risk of low quality responses / behavior.
The numerical/integer ID for this Status is: 4
The respondent in this case was routed to the client survey.

ClientQualTerm#

Description: Respondent was terminated in the client survey due to being flagged for poor Quality
Remediation: Inspect activity of respondent to see if other fraud markers were present on your platform. No further action needed unless happening in large volumens; otherwise, contact InnovateMR team.

Complete#

The Complete survey transaction status is rendered when the respondent was routed to the client survey and completed the questionnaire.
The numerical/integer ID for this Status is: 1
The respondent in this case was routed to the client survey.
Also known as Qualified or Success.

HTTPRef#

Description: Respondent completes the client survey but is redirected and the HTTP_REFERER header is missing
Remediation: No action needed unless happening in large volumens; otherwise, contact InnovateMR team.

PreSurveyDNC#

This status is rendered when the respondent lands on/routed to the InnovateMR platform but abandons before receivng another status / being routed to the client survey.
The numerical/integer ID for this Status is: 0
Also known as Click or Click-Abandon
The respondent in this case was not routed to the client survey.

StartSurveyDNC#

This status is rendered when the respondent is routed to the client survey but never returns.
The numerical/integer ID for this Status is: 6
Also known as Abandon or Start-Abandon
The respondent in this case was routed to the client survey.
Previous
Respondent-Survey Flow
Next
Onboarding Checklist
Built with