Implementation
This page covers how to use your hosted link: the URL format, the value you substitute per user, and what happens when a user opens the link.
You need a TapResearch account and a Hosted Link app before you begin. Don't have an account yet? Sign up, then grab your hosted link from the Publisher Dashboard.
The hosted link format
Your dashboard generates the hosted link for you. It points at one of your
placements — identified by your app title identifier and the placement
tag in the path — and carries the user you're sending in the uid query
parameter:
https://www.tapresearch.com/supply_api/v4/app_titles/<APP_TITLE_IDENTIFIER>/placements/<PLACEMENT_TAG>/redirect?uid=<USER_IDENTIFIER>
There is no API token in the link — the Hosted Link requires no authentication. The dashboard fills in the path for you; you only substitute the per-user identifier.
Values to substitute
The <APP_TITLE_IDENTIFIER> and <PLACEMENT_TAG> are already filled in by the
dashboard and are fixed per placement. Before you send a user to the link, fill
in the user value:
| Value | Location | Required | Description |
|---|---|---|---|
<USER_IDENTIFIER> | uid query param | Yes | A persistent, unique identifier for the user. Swap this per user so rewards are attributed to the right account. Reuse the same value for a given user across sessions. |
did | Query param | No | An optional identifier for the user's device. |
The hosted link is the same for every user except for the per-user uid.
Template the link once, then substitute the current user's value at the moment
you hand them the link.
Requirements:
- Use a stable
uidfor each user — the same value should map to the same user every time. - URL-encode any values that contain special characters.
What happens when a user opens the link
Opening the hosted link hands the user off to the TapResearch-hosted experience — you don't select, render, or redirect to anything yourself:
- We check what's available for the user. Eligibility and targeting are handled entirely on TapResearch's side — there's no eligibility call for you to make.
- The user enters the survey experience. First-time users go through a short profiling flow, then land on the TapResearch survey wall, where they browse and take their available surveys.
- Otherwise, they see a "no surveys available" message. If the user isn't currently eligible for anything, they get a friendly, localized message instead. No reward is issued in this case.
After a user completes a survey, TapResearch notifies your backend asynchronously — see Callbacks.
Next steps
- Callbacks — set up the server-to-server postback so you're notified when a user earns a reward.