Get Surveys

get

https://api.bitlabs.ai/v2/client/surveys

Returns a list of surveys that are available for the current user. This is the endpoint that should be used to display surveys to the user. If a simple integration flow is desired, this is the only endpoint that must be implemented. Redirecting to the click_url property of the returned surveys will open the survey in the BitLabs.

Query Params

platform

string

enum

deprecated

Platform/Device type of the user

Allowed:

os

string

enum

deprecated

Operating System of the user

Allowed:

sdk

string

enum

SDK the user is using

Allowed:

tags

string

Optional set of key-value pairs to be passed back in callbacks. Max 10 pairs with both key and value up to 50 characters long. Keys and values are trimmed and lower-cased. Keys can only contain alphanumeric characters and underscores. Values can contain any characters. If you need to pass sensitive information, note that users can potentially manipulate this data.

client_ip

string

Allows overriding the ip that is used for this request. This feature must be enabled by your account manager!

client_useragent

string

Allows overriding the useragent that is used for this request. This feature must be enabled by your account manager!

username

string

Allows specifying a display name for the requesting user which is used for features such as the leaderboard. Nothing happens if it is not set. Only alpha-numeric characters are allowed.

maid

string

optional mobile advertising id (MAID)

network_blacklist

string

optional comma separated list of networks to exclude from the response

algo

string

enum

Allows overriding the survey sorting algorithm configured for this app.

Allowed:

email

string

optional email address of the user

Response

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json