Get Top Pick Surveys

GET 
/Surveys/getTopPickSurveys

About Api Returns a list of top pick surveys allocated to a user.

Request

Header Parameters

ZAMP-KEY stringrequired

Responses

200

This response you will get on a successful request

application/json

Schema

Schema

success boolean
apiVersion integer
message string

result

object

success boolean

TotalCount integer

data

object[]

Array [

SurveyId integer

Name string

TotalCompleteRequired integer

CPI float

LOI integer

IR integer

LastUpdateTimeStamp date-time

IsSurveyGroupExist integer

LanguageCode string

ApiClientId integer

SurveyEndDate date-timenullable

Device string

IndustryId stringnullable

status string

StudyTypes string

IsRecontactSurvey integer

CollectPII integer

LanguageId integer

FieldDays stringnullable

SurveyCreatedAt date-time

Conversion string

]

Example (from schema)

{
  "success": true,
  "apiVersion": 1,
  "message": "Request Success",
  "result": {
    "success": true,
    "TotalCount": 4,
    "data": [
      {
        "SurveyId": 1564171233,
        "Name": "Other Survey",
        "TotalCompleteRequired": 408,
        "CPI": 1.1,
        "LOI": 8,
        "IR": 90,
        "LastUpdateTimeStamp": "2025-09-09T22:04:50.000Z",
        "IsSurveyGroupExist": 0,
        "LanguageCode": "Spanish-MX",
        "ApiClientId": 10,
        "SurveyEndDate": "2025-09-24T18:20:45.000Z",
        "Device": "Both",
        "IndustryId": "30",
        "status": "Live",
        "StudyTypes": "ADHOC",
        "IsRecontactSurvey": 0,
        "CollectPII": 0,
        "LanguageId": 31,
        "FieldDays": null,
        "SurveyCreatedAt": "2025-09-09T18:20:45.000Z",
        "Conversion": "4.55"
      }
    ]
  }
}

400

Bad Request. Please ensure you are passing all the required params and header info.

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "Unauthorized"
}

401

Please ensure that you are using the correct API environments and sending the correct ZAMP-KEY in the request header.

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "ZAMP-KEY key is invalid"
}

404

Please ensure that you are using the correct environments with the correct API name.

500

There is some issue facing at Zamplia Server Side. Please contact support.

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "Internal server error"
}

Loading...