Get Survey Stats

Sandbox Env

https://supplier-stage.surveysherpa.com

GET

/api/v1/supply/getSurveyStats/{Survey ID}

This API allows suppliers to access real-time statistics for their allocated surveys. The data includes metrics such as clicks, completes, failures, over-quotas, revenue, and other traffic-related information.

Request

Path Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://supplier-stage.surveysherpa.com/api/v1/supply/getSurveyStats/123 or 121' \
--header 'x-access-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2NzA4ZGVlNmUwNjRmMmE1NmM2MTg1MjEiLCJzdXBwbGllcl9pZCI6MiwiaWF0IjoxNzI4NjQzNDA2fQ.Ia1yhS01Pt-YxHff0aNRZZp2U7apiYmyKqOto6ktjOE'

Responses

🟢200OK

application/json

Body

Example

{
    "apiStatus": "success",
    "msg": "Survey Stats are successfully searched",
    "result": {
        "clicks": 3,
        "surveyStarts": 3,
        "completes": 2,
        "fails": 2,
        "overQuota": 0,
        "qualityTerms": 0,
        "preSurveyTerminates": 0,
        "preSurveyOverQuota": 0,
        "preSurveyQualityTermination": 0,
        "averageLOI": "105:08",
        "revenue": 10,
        "conversion": 66.67
    }
}

Modified at 2025-08-20 05:34:10

Get Survey Transactions Data

Get Recontacts