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

Core Metadata Fields

Production Endpoint
https://supplier.innovatemr.net/api/v2
Production Endpoint
https://supplier.innovatemr.net/api/v2
GET
https://supplier.innovatemr.net/api/v2
/mapping/metadata/{fields}
Core Metadata Fields
This API will allow supplier to get the details of core metadata fields with the specified fields.( i.e. country, groupType, language, jobType, questionType etc passed in request with comma separated). At least one argument must be required.

Request

Path Params
fields
string 
required
pass value as comma separated like country, category, language, survey status, device type, group type, dma mapping, job type, question type
Header Params
x-access-token
string 
required
YOUR_X-ACCESS-TOKEN_HERE

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://supplier.innovatemr.net/api/v2/mapping/metadata/' \
--header 'x-access-token;'

Responses

🟢200OK
application/json
Body
apiStatus
string 
required
result
object 
required
countries
array [object {2}] 
required
categories
array[string]
required
jobTypes
array[string]
required
questionTypes
array[string]
required
languages
array [object {2}] 
required
groupTypes
array[string]
required
deviceType
array[string]
required
surveyStatus
object 
required
dmaMapping
array [object {3}] 
required
msg
string 
required
Example
{
    "apiStatus": "string",
    "result": {
        "countries": [
            {
                "name": "string",
                "code": 0
            }
        ],
        "categories": [
            "string"
        ],
        "jobTypes": [
            "string"
        ],
        "questionTypes": [
            "string"
        ],
        "languages": [
            {
                "name": "string",
                "code": 0
            }
        ],
        "groupTypes": [
            "string"
        ],
        "deviceType": [
            "string"
        ],
        "surveyStatus": {
            "PreSurveyDNC": 0,
            "Completed": 0,
            "Failed": 0,
            "OverQuota": 0,
            "QualityTermination": 0,
            "PreSurveyTermination": 0,
            "StartSurveyDNC": 0,
            "PreSurveyOverQuota": 0,
            "PreSurveyQualityTermination": 0
        },
        "dmaMapping": [
            {
                "OptionId": 0,
                "DMA_NAME": "string",
                "DMA_CODE": 0
            }
        ]
    }
}
Previous
Delete Global redirect URLs and Pixels for supplier’s account
Next
Get Question Categories
Built with