Skip to main content
Version: 3.x

TapResearch Surveys API

Welcome to the TapResearch Surveys API documentation. These endpoints allow partner systems to register participants, fetch available surveys, and manage qualification and country data.

Use this guide to ensure secure, reliable integrations and consistent user experiences.

Base URL​

All endpoints in this API are prefixed with the following base URL:

https://api.tapresearch.com/supply_api/v4

For example:

  • Countries: GET https://api.tapresearch.com/supply_api/v4/countries
  • Impanel: POST https://api.tapresearch.com/supply_api/v4/players/impanel
  • Campaigns: GET https://api.tapresearch.com/supply_api/v4/campaigns

All requests must be made over HTTPS.

Overview​

Partners can integrate with TapResearch using two different paths:

Path 1: Partners Pass Profile Data (Full Integration)​

In this flow, partners collect profiling and demographic data from their users, then pass that information to TapResearch using the Impanel endpoint. TapResearch stores and uses this data to determine qualification for surveys.

This path uses multiple endpoints:

  • Retrieve supported countries and qualification questions.
  • Register (impanel) participants and send profile responses.
  • Fetch live survey campaigns available to qualified participants.
  • Handle secure redirect URLs for completions and terminations.

Path 2: TapResearch Handles Profiling (Simplified Integration)​

In this flow, partners do not collect profile data themselves. Instead, TapResearch shows users our built-in profiling experience.

For this integration, the only required endpoint is:

GET /campaigns — returns a profile survey if the user has not been profiled. Once profiling is complete, this endpoint returns the best available surveys for that participant.

Endpoints​

EndpointMethodDescription
/countriesGETList supported countries and their IDs.
/qualificationsGETRetrieve qualification questions per country.
/players/impanelPOSTRegister a participant and store qualification responses.
/campaignsGETFetch available surveys for a qualified participant.

Authentication​

Every request requires your assigned API token. Some endpoints also require a security hash (sech), which is generated using your API secret.

The secret should never be sent in any request.

Learn more in Authentication.

Security and Redirects​

To ensure authenticity and integrity:

  • See Security Hash for generating and validating signed requests.
  • See Redirect URLs for signing and validating redirect query parameters.

Reference Sections​

  • Redirect Statuses — standardized participant outcome codes.
  • Best Practices — caching, retries, and timing recommendations.
  • Support — TapResearch contact information for integration help.

Support​

For credentials, redirect configuration, or questions about either integration path, please contact your TapResearch account manager or email: developers@tapresearch.com