Skip to main content
POST
Get All Live Surveys

Get All Live Surveys

Retrieve a list of all live surveys based on filtering criteria.
Note: The rows parameter accepts a maximum value of 500 surveys per page. The fields loi and ir are deprecated. Please use length_of_interview and incidence_rate instead.

Endpoint

Headers

Note: The publisher-authentication-key header corresponds to your Secret Key. The authorizationKey in the request body corresponds to your Web API Key.

Request Body

Response

Error Response

Authorizations

publisher-authentication-key
string
header
required

Send your Secret Key using the publisher-authentication-key header. This header is required for every request.

Body

application/json

Payload for retrieving live surveys. Includes your Web API Key plus optional filtering criteria.

authorizationKey
string
required

Web API Key (maps to authorizationKey field in SDK).

Example:

"DqcInvhIFAl5WtUNwihFUIgUH77EL2hTNRU"

country
string
required

ISO 2-letter country code (e.g., US, IN).

Example:

"US"

language
string

Language name for survey targeting.

Example:

"English"

lengthOfInterviewGTE
integer

Minimum length of interview in minutes.

Example:

1

lengthOfInterviewLTE
integer

Maximum length of interview in minutes.

Example:

5

collectPII
boolean

Only return surveys that collect personally identifiable information.

Example:

false

rows
integer

Number of surveys to return per page (1-500).

Required range: 1 <= x <= 500
Example:

50

page
integer

Page number for pagination (starts from 1).

Required range: x >= 1
Example:

1

CPIGTE
number<float>

Minimum CPI value.

Example:

1

CPILTE
number<float>

Maximum CPI value.

Example:

5

surveyGroupExists
boolean

Filter by whether a survey group exists.

Example:

false

incidenceRateGTE
integer

Minimum incidence rate.

Example:

1

incidenceRateLTE
integer

Maximum incidence rate.

Example:

25

Response

Successful response with list of live surveys

success
boolean
required
Example:

true

surveys
object[]
required
surveysCount
integer
required

Number of surveys returned in this response

Example:

3

pagination
object
projectName
string
Example:

"New Campaign 007"

projectNumber
integer
Example:

10000092

organisation
string
Example:

"Mirats Quanto DIY"