Get survey stats

Production Endpoint

https://supplier.innovatemr.net/api/v2

GET

/supply/getSurveyStats/{Survey ID}

This API allows suppliers to get real time statistics for allocated survey. This will return data like number of clicks, completes, fails, over quota, revenue etc. for supplier’s traffic.

Request

Path Params

Survey ID

string

required

Survey Id of particular survey (like : 6614)

Header Params

x-access-token

string

required

YOUR_X-ACCESS-TOKEN_HERE

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://supplier.innovatemr.net/api/v2/supply/getSurveyStats/' \
--header 'x-access-token;'

Responses

🟢200OK

application/json

Body

apiStatus

string

required

msg

string

required

result

object

required

isVerified

boolean

required

clicks

integer

required

surveyStarts

integer

required

completes

integer

required

fails

integer

required

overQuota

integer

required

qualityTerms

integer

required

preSurveyTerminates

integer

required

preSurveyOverQuota

integer

required

preSurveyQualityTermination

integer

required

averageLOI

string

required

revenue

number

required

Conversion

string

required

numberOfCompletes

integer

required

numberOfStarts

integer

required

globalBuyerConversion

string

required

globalMedianLOI

string

required

sourceSurveyIDs

array[integer]

required

exclude

array[string]

required

include

array[string]

required

Example

{
    "apiStatus": "success",
    "msg": "Survey Stats are successfully searched",
    "result": {
        "isVerified": false,
        "clicks": 52,
        "surveyStarts": 19,
        "completes": 13,
        "fails": 0,
        "overQuota": 0,
        "qualityTerms": 0,
        "preSurveyTerminates": 21,
        "preSurveyOverQuota": 1,
        "preSurveyQualityTermination": 0,
        "averageLOI": "0.23",
        "revenue": 3.379999999999999,
        "Conversion": "68.42",
        "numberOfCompletes": 3,
        "numberOfStarts": 3,
        "globalBuyerConversion": "100.00",
        "globalMedianLOI": "0.26"
    }
}

Get PIDs for re-contact surveys (studies)

Set Panellist Profiling