1. Text Analyzer 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
      GET
  1. Text Analyzer API

API Details

Production Endpoint
https://apivisionsampling.innovatemr.com/api/v2
Production Endpoint
https://apivisionsampling.innovatemr.com/api/v2
GET
https://apivisionsampling.innovatemr.com/api/v2
/textAnalyzer/getTAResponse

Request

Header Params
x-access-token
string 
optional
YOUR_X-ACCESS-TOKEN_HERE
Content-Type
string 
optional
application/json
Body Params application/json
jobNumber
number 
required
This is the unique number for API transaction
jobName
string 
optional
This is the name for API transaction
questionId
string 
required
Question Id/Custom question text of the answer text
answer
string 
required
Answer text
supplier
string 
optional
Name of Supplier eg: “Test Supplier”
languageCode
string 
required
Language code e.g : en(for English)
templateId
number 
required
Id of template uploaded to which OE response needs to be compared
timeDifference
number 
optional
Time Difference
Example
{
  "jobNumber": 12345,
  "jobName": "Sample API Transaction",
  "questionId": "Q123",
  "answer": "This is the answer text.",
  "supplier": "Test Supplier",
  "languageCode": "en",
  "templateId": 67890,
  "timeDifference": 30
}

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://apivisionsampling.innovatemr.com/api/v2/textAnalyzer/getTAResponse' \
--header 'x-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "jobNumber": 12345,
  "jobName": "Sample API Transaction",
  "questionId": "Q123",
  "answer": "This is the answer text.",
  "supplier": "Test Supplier",
  "languageCode": "en",
  "templateId": 67890,
  "timeDifference": 30
}'

Responses

🟢200Success
application/json
Body
response
object 
required
_id
string 
required
result
string 
required
OEResponse
object 
required
Example
{
    "apiStatus": "success",
    "msg": "OE processed successfully",
    "response": {
        "_id": "5f64a1b8488d7a7e95cb367c",
        "result": "accepted",
        "OEResponse": {
            "answer_chars": "22",
            "n_words": "5",
            "profanity_score": "0",
            "cp_score_1": "0.06",
            "cp_score_2": "0.68",
            "spelling": "0",
            "n_sentences": "1",
            "mn_sentence_length": "5",
            "past_oe": "1",
            "exec_time": "0.088",
            "n_past_oes": "7",
            "is_url": "0",
            "oe_rate": "1",
            "contextuality": "1",
            "error_message": "NA",
            "client": "44",
            "email": "0",
            "SSN": "0",
            "IPv4": "0",
            "date": "0",
            "visa": "0",
            "license": "0",
            "ZIP": "0",
            "address": "0",
            "fname": "0",
            "lname": "0",
            "study": "10000"
        }
    }
}
Previous
Text Analyzer API - FAQ
Built with