Skip to main content

Frequently Asked Questions

Monetization API​

What do we need to get started?​

Before getting started with the inBrain API integration, you will need to setup an account on our Publisher Dashboard. Once that is complete, contact your account rep or email us at [email protected] to request API keys needed for testing.

My API Credentials don't seem to work.​

It's not uncommon to get API credentials mixed up or copied incorrectly, double check those and contact us if your having an issue. It's important to note that the API Keys in the Publisher Dashboard are NOT for API integration, those are for the SDK integration. You must contact your inBrain account rep to request API integration Keys.

Do you provide partial rewards for survey disqualifications?​

Yes, we provide partial survey rewards for disqualifications and are configured on a case by case scenario. Please contact your account rep for more information. Currently Partial rewards are limited to 6 per 24 hour period.

Is there a way to specify minimum (or Maximum) Value for Surveys?​

Yes! We have a unique feature called Placement Filters. Let us know what Min/Max values to set for this filter and we can get it setup for you. You will receive a placementId guid that can be passed via the SDK. This will ensure that the surveys returned match the filter min/max you have defined.

Is there a way to specify minimum (or maximum) Length (in minutes) for Surveys?​

Yes! We have a unique feature called Placement Filters. Let us know what Min/Max values to set for this filter and we can get it setup for you. You will receive a placementId guid that can be passed via the SDK. This will ensure that the surveys returned match the filter min/max you have defined.

Do we have to use Server-to-Server callbacks?​

It's not required to use these server callbacks. If you have a Client/Server architecture, then we highly recommend this secure and redundant method for receiving user rewards from inBrain. If you opt not to use server callbacks, you can utilize in app reward retrieval

Do we have to use a "Test User" during testing? How does this work?​

Yes, before testing surveys, be sure to add a "Test User" to the Publisher Dashboard and pass this Test User value as your user_id when fetching surveys. Only Test Users will see testing surveys prior to your integration being put into Live mode. Once your app goes Live, these Test Users will continue to see Testing Surveys. This makes for easy testing and troubleshooting while your app integration is live.

Can get the total survey inventory available for a user?​

inBrain's survey inventory is not intended to be pulled in it's entirety for a specific user. Instead, inBrain provides both an API and SDK's that allow fetching surveys on demand for a user identified by a unique respondent identifier. Our yield management system is designed to return the best surveys for a given respondent at a specific point in time.

How can we track our own user data through the inBrain experience?​

We provide a MID parameter you can add to survey entry links when using the inBrain API. More detail about that here: https://docs.inbrain.ai/docs/supplier-api/specifications/entry-link#parameters. Note that when adding the MID parameter, you will need to re-sign the entry link according to this documentation: https://docs.inbrain.ai/docs/supplier-api/specifications/entry-link#entry-link-modification

Do we have to provide profiler data when requesting surveys for a user?​

Yes it is important to provide at least some profiler data when requesting surveys for a user. This allows for better initial survey matching and higher qualification rates. Documentation on the mappings for those questions and answers is provided here: https://docs.inbrain.ai/docs/supplier-api/api-endpoints/fetch-surveys#profiler-data-parameters. In this documentation section there is a link to a xlsx file download with these profiler data point mappings.

Does the user_id have to be unique?​

Yes, the user_id MUST be unique to each user within your app. Our system relies on this unique user id for proper yield management of surveys for each user.

Do you have Question/Answer mappings for profiler data points?​

Yes, you can find the xlsx download here: https://docs.inbrain.ai/docs/supplier-api/api-endpoints/fetch-surveys#profiler-data-parameters

Is LocalStorage required to use inBrain Surveys?​

Currently inBrain surveys have dependency to localStorage, or better, localStorage is required for surveys to work properly. We are exploring ways to loosen that dependency, but we haven't made any decision on that topic yet.

With the surveys returned, there is no survey_id or identifier for the survey, so how can we know if the user has already taken it?​

Once a survey has been attempted by a user, inBrain API does not return that same survey in any further requests to fetch surveys for the same user.

What happens if we don’t pass through the language? Does your system ask the user what language they prefer?​

In that case inBrain resolves the geo of the user based on IP, which is then used to resolve the language. For example, if user's geo is Australia its language will be set to English (en-au). As you could see in the list of supported geos/languages, in most of the geos we support a single language, while there is a slight difference in US and Canada where we support multiple languages. In case when language for the user is not provided and user's geo is US or Canada, its language will be set to the default language for that geo (English - en-us or en-ca respectively).