To ensure a successful onboarding, there are two areas of mapping that have to be addressed.

Platform Metadata

Object properties and platform-wide values like Countries and Languages

Questions and Answers

These are survey qualifications / respondent demographic information.

Platform Metadata

These pieces of metadata are essential to interpretting and categorizing events, actions, and objects on the InnovateMR platform.

We offer API Endpoints for you to programatically ingest these pieces of metadata. You can find more info here: Core Metadata Fields

Name	Description	Metadata Key
Countries	Names and Two-character Codes for Countries	country
Languages	Names and Two-character Codes for Languages	language
Survey Categories	All surveys are associated with a category that describes them.	category
Survey Statuses	List of Survey Transaction Statuses that are assigned based on the experience of the respondent.	surveystatus
Job Types	All Surveys have a Job (think Parent of a Survey) and Jobs have Types which describe the style of research.	jobtype
Group Types	All Surveys have a Type which describes its targeted audience. grouptype
Device Types	All Surveys have a list of devices they are allowed to be particpated on.	devicetype
DMA Mappings	The InnovateMR platform uses DMA Names in addition to DMA Codes. This is a list of the mappings between DMA Codes and DMA Names.	dmamapping

While new values can technically be added over time, these values can be considered static and only need to be mapped once. If there should be any changes made to these pieces of metadata, the InnovateMR team will be sure to communicate the details.

Questions & Answers

Questions and Answers, or also known as Qualifications, are one of the most important areas of the InnovateMR platform. These will be used in Survey Targeting and Respondent Management efforts.

These Questions ans Answers are used in Survey Targeting and Survey Quotas so it is important to make sure that the corresponding values on your platform are mapped appropriately. Otherwise Terminations will be observed due to respondents not matching the Survey qualifications.

We offer several ways of retrieving Questions and their associated answers - see below.

Please note that some questions are Global (ex: Age) and some are Local (ex: State) depending on their nature.

Additionaly, our Question Library changes over time, so it is recommended to perform a routine audit of the mapped question inventory to ensure mappings are kept up to date.

Question Model

Technial Details on the attributes of Question Model can be found here. but here's example for us to discuss.

{
  "QuestionId": 3537,
  "QuestionText": "What online streaming video services do you regularly use?",
  "QuestionKey": "CORE_ENTERTAINMENT_0015",
  "QuestionType": "Multipunch",
  "language": "ENGLISH",
  "Category": [
    "Technology",
    "Entertainment"
  ]
}

Details of the model properties

Property	Description
QuestionId	Numerical ID of the Question.
QuestionText	The prompt that is presented to respondents.
QuestionKey	The Primary Identifier of the Question which is used throughout the InnovateMR platform
QuestionType	The answer type of the Question.
language	The associated language of the Question
Category	The associated Question Categories of the Question

Note: That a Question can belong to multiple Question Categories.

Question Library By Country-Language

To retrieve all of the questions by a Market/Culture (Country-Language combination) you can use the Get Questions By Country & Lanaguage API Endpoint

Please note that value to pass in for Country is the Country Code (ex US), and for Language pass in the Language Name (ex ENGLISH) which is also case sensitive.

Question Categories

Questions on the InnovateMR platform are segemented into different Question Categories. These categories are intended to be helpful in Question management and add context to their associated Questions.

To view a list of Question Categories you can make a call to the Get Question Categories API Endpoint.

Also, the details of the Question Category Model can be found here.

The use of this endpoint, or Question Categories, is optional and meant to make question management easier.

Questions by Category

Once you have the list of Question Categories pulled down, you can now retrieve the Questions associated with each Question Category.

This is accomplished through the Get Questions By Category API Endpoint.

Please note that the value to pass in for the Question Category is the two digit Category code (ex: DM) not the Category name (ex. Demographic).

Also, since Questions can belong to multiple Question Categories the ingestion process should account for this accordingly.

Answer Model

Technial Details on the attributes of Answer Model can be found here. but here's example for us to discuss.

{
 ...
 "QuestionOptions": [
    {
      "id": 1,
      "OptionText": "ACSC  (AAA)",
      "Order": 1
    },
    {
      "id": 2,
      "OptionText": "Allstate",
      "Order": 2
    },
    {
      "id": 3,
      "OptionText": "American Family",
      "Order": 3
    }
 ]
...
}

Details of the model properties

Property	Description
id	Numerical ID of the Answer. This is local to the Question.
OptionText	The answer value that the respondent can choose.
Order	Order that the answer option will be presented to the respondent (Ascending order).

Please note: For Open End or Numeric Open End type of Questions, there are no Answer Options since the respondent provides the value.

Get All Answers for a Question

Once you have all of the questions you intend to map, you can find their corresponding Answers through the Get Answers by Question Key API Endpoint

Example Response for Single Punch Question The available Answers (Question Options) are listed in an array/list format.

{
  "apiStatus": "success",
  "msg": "Answers are successfully searched",
  "result": {
  "QuestionId": 4,
      "QuestionText": "Which of the following best describes your race?",
      "QuestionType": "Single Punch",
      "QuestionKey": "ETHNICITY",
      "QuestionOptions": [
        {
          "id": 1,
          "OptionText": "White",
          "Order": 1
        },
        {
          "id": 2,
          "OptionText": "Black or African American",
          "Order": 2
        },
        {
          "id": 3,
          "OptionText": "American Indian or Alaska Native",
          "Order": 3
        },
        {
          "id": 4,
          "OptionText": "Asian - Asian Indian",
          "Order": 4
        }
        ...
  }
}

Example Response for a Numeric Open End or Open End Question The available Answers (Question Options) is an empty list since it is to be provided by the respondent.

{
  "apiStatus": "success",
  "msg": "Answers are successfully searched",
  "result": {
    "QuestionId": 1,
    "QuestionText": "What is your age?",
    "QuestionType": "Numeric Open Ended",
    "QuestionKey": "AGE",
    "QuestionOptions": []
  }
}

When retrieving the answer options from this endpoint there are two optional paramters that can be passed in: Country and Language.

Please note that the value to pass in for the Country is the two digit Country code (ex: US) not the Country name (ex. United States). However, the Langauage name should be used and is case sensitive.

Commonly Asked Questions

Do I need to map all Questions & Answers?

Short answer - no. Long answer - it is recommended to map a many question and answers as possible so that matching surveys to respondents is richer and leads to a better conversion rate.

What are the most widely used Questions

This depends on the markets in which business is being conducted. Please reach out to the InnovateMR for a tailored answer based on your reach.

Mapping

Platform Metadata#

Questions & Answers#

Question Model#

Question Library By Country-Language#

Question Categories#

Questions by Category#

Answer Model#

Get All Answers for a Question#

Commonly Asked Questions#

Do I need to map all Questions & Answers?#

What are the most widely used Questions#

Platform Metadata

Questions & Answers

Question Model

Question Library By Country-Language

Question Categories

Questions by Category

Answer Model

Get All Answers for a Question

Commonly Asked Questions

Do I need to map all Questions & Answers?

What are the most widely used Questions