Integrate BitLabs using our API

This article shows you how to integrate BitLabs using the API, for most advanced integration and customization.

Postman Documentation

Please read the postman decimation carefully. All necessary endpoints are listed there. You can switch example responses.

docs.bitlabs.ai


Integration Flow

General Idea

The general idea of the Data Feed API is to provide full access to all surveys and qualifications. The publisher himself can use it to natively integrate the questions of qualification into his product and get back matching surveys.

Receive Surveys & Qualifications

The Get Actions endpoint returns all matching surveys for a user, as well as the next qualification. By having these two kinds of actions the publisher can decide if a user takes part in a survey or answering a profile question to meet more qualifications and thereby get more matching surveys.

First Time Calling

The first times the Get Actions endpoint is called it will return only qualifications to collect a core profile before returning matching surveys.

VPN Restrictions

There could be restrictions on single users for using a VPN tool or other quality issues. Please check possible restrictions in the postman doc.

Open a survey

Use the link of the Get Action endpoint if you like to send a user into a survey. Just open this link in an iFrame or Webview and pass the necessary parameters. The endpoint will redirect to the survey itself.

Start a Qualification

By answering more questions the user will receive additional surveys.
Each Get Action response contains the next qualifications that has to be asked (if available).

Post the Answer back to Bitlabs by calling Answer Question.

After you answered the latest qualification it is mentioned to refresh the Get Actions endpoint. By doing this you will receive an updated list of matching surveys and also a possible next qualification for additional surveys.

With the endpoints of Get Actions → Answer Question → Get Actions you can create a qualification loop to ask multiple questions in a row. Customize this process the way you like.

Skip Surveys or Qualifications

By calling the Skip Question or Skip Survey endpoint you can give the user the opportunity to receive another survey or qualification.

Please keep in mind, that the user will receive fewer surveys by skipping a Qualification. Also, skipped surveys will never be available again.

Leave a Survey

You can optionally pass back a reason if a user left a survey. This helps us to improve the ranking of a survey. Simply call Lave Survey with the right reason code.

User History

If you like to build a user history in your product you can receive the latest action for a survey by calling the User History endpoint. It will always return the latest tracked action (opening, leave, screenout or complete) for a survey. In addition to that it returns all the stored details about a survey.

Privacy Actions

It is very important for us to be full transparent on the data we collect.
That’s why we provide two endpoints to give you the control about user data. With these endpoints you can process data requests (User Data endpoint) and data deletion request (Delete User Data endpoint).

Please note, that you are required by law to forward the different privacy requests of your users to all third-party companies you work with.