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

Get Allocated Surveys By Id

Production Endpoint
https://supplier.innovatemr.net/api/v2
Production Endpoint
https://supplier.innovatemr.net/api/v2
GET
https://supplier.innovatemr.net/api/v2
/supply/getAllocatedSurveysBySurveyId/{Survey ID}
This API will allow supplier(s) to get Survey Status, if survey is Live then survey data will be provide else return Paused/Closed message.

Request

Path Params
Survey ID
integer 
required
Survey Id of particular survey (like : 12632)
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/supply/getAllocatedSurveysBySurveyId/' \
--header 'x-access-token;'

Responses

🟢200OK
application/json
Body
apiStatus
string 
required
msg
string 
required
result
array [object {39}] 
required
surveyId
integer 
optional
surveyName
string 
optional
N
integer 
optional
isRevShr
boolean 
optional
supCmps
integer 
optional
remainingN
integer 
optional
LOI
integer 
optional
IR
integer 
optional
Country
string 
optional
CountryCode
string 
optional
Language
string 
optional
LanguageCode
string 
optional
groupType
string 
optional
deviceType
string 
optional
createdDate
string 
optional
modifiedDate
string 
optional
reContact
boolean 
optional
entryLink
string 
optional
testEntryLink
string 
optional
CPI
string 
optional
isQuota
boolean 
optional
jobCategory
string 
optional
isPIIRequired
boolean 
optional
JobId
integer 
optional
BuyerId
integer 
optional
expected_end_date
string 
optional
duplicateSurveyIds
array[string]
optional
duplicateCheckLevel
string 
optional
statuses
array[string]
optional
numberOfCompletes
integer 
optional
numberOfStarts
integer 
optional
globalBuyerConversion
string 
optional
globalMedianLOI
string 
optional
QuestionId
integer 
required
QuestionText
string 
required
QuestionKey
string 
required
QuestionType
string 
required
language
string 
required
Category
array[string]
required
Example
{
    "apiStatus": "success",
    "msg": " All live groups are successfully searched",
    "result": [
        {
            "surveyId": 12632,
            "surveyName": "Basic Demo With Beverage survey",
            "N": 100,
            "isRevShr": true,
            "supCmps": 3,
            "remainingN": 97,
            "LOI": 15,
            "IR": 10,
            "Country": "United States",
            "CountryCode": "US",
            "Language": "ENGLISH",
            "LanguageCode": "EN",
            "groupType": "Consumer",
            "deviceType": "All",
            "createdDate": "09/11/2017, 11:03:50 pm PST",
            "modifiedDate": "09/11/2017, 11:50:27 pm PST",
            "reContact": false,
            "entryLink": "http://innovate-stage-209385288.us-east-1.elb.amazonaws.com/startSurvey?survNum=86NMz1YX&supCode=225&PID=[%%pid%%]",
            "testEntryLink": "",
            "CPI": "4.50",
            "isQuota": true,
            "jobCategory": "Beauty/Cosmetics",
            "isPIIRequired": false,
            "JobId": 9175,
            "BuyerId": 136,
            "expected_end_date": "09/21/2018",
            "duplicateSurveyIds": [],
            "duplicateCheckLevel": "NA",
            "statuses": [],
            "numberOfCompletes": 3,
            "numberOfStarts": 3,
            "globalBuyerConversion": "100.00",
            "globalMedianLOI": "0.26"
        }
    ]
}
Previous
Get Allocated Surveys (all live surveys)
Next
Get Allocated Surveys By Date (live surveys only)
Built with