1. --- Start Here ---
  • Supplier API
    • Supplier API – FAQ
    • HTTP Status Codes
    • --- Start Here ---
      • Onboarding Process
      • Mapping
      • Survey Inventory Management
      • Respondent-Survey Flow
      • Statuses, Term Reasons & Categories
      • Onboarding Checklist
      • API Call Flow
      • Frequently Asked Questions (FAQ)
      • Complete Validation Notifications
    • --- APIs ---
      • 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
    • Buyer API - FAQ
    • 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
  • Text Analyzer API
    • Text Analyzer API - FAQ
    • API Details
  • Postbacks/Redirects
    • Redirect URL
    • PostBack URL
    • Hashing Mechanism
    • Redirect URL Helper
  • View Change Log
    • View Change Log
  • Schemas
    • Sample Schemas
      • Pet
      • Category
      • Tag
  1. --- Start Here ---

Frequently Asked Questions (FAQ)

What is a survey transaction (tx)?#

Think of this as an attempt by a respondent to take a survey.

What is a token?#

The unique identifier of a survey transaction.

What is a Group?#

A Group is the equivalent of a Survey. Feel free to use them interchangably.

What is a Job?#

A Job is then parent of a Survey and used for organizationl and administrative purposes. A Job can have many Surveys but a Survey can only belong to one Job.
It is recommended that you store respondent survey attempts by both Job ID and SurveyID.

What is a PID?#

The unique, persistent Identifier of a respondent.

What is a Redirect Url?#

The web address that a respondent is sent to once their survey experience is over on the InnovateMR platform.
Modified at 2025-09-04 10:44:16
Previous
API Call Flow
Next
Complete Validation Notifications
Built with