Implementation
This page covers how to build and use your hosted link: the URL format, the values you substitute per user, and what happens when a user opens the link.
You need a TapResearch account and your placement's offer identifier before you begin. Don't have an account yet? Sign up, then find your offer identifier in the Publisher Dashboard.
The hosted link format
The hosted link is a single URL that you template per user. It points at a
specific placement — your offer identifier, in the path — and carries the
user you're sending in the uid query parameter:
https://www.tapresearch.com/router/offers/<OFFER_IDENTIFIER>/pre_entry?uid=<USER_IDENTIFIER>
There is no API token in the link — the Hosted Link requires no authentication. You only need your offer identifier and a per-user identifier.
Values to substitute
Before you send a user to the hosted link, fill in these values:
| Value | Location | Required | Description |
|---|---|---|---|
<OFFER_IDENTIFIER> | Path | Yes | Identifies the placement to route the user into. Found in the Publisher Dashboard. Fixed per placement. |
<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. |
tid | Query param | No | An optional transaction identifier you supply for your own tracking. If you include it, it is echoed back to you on the reward callback. |
The hosted link is the same for every user except for the per-user uid (and the
optional tid). Template the link once, then substitute the current user's values
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.
Redirect behavior
When a user opens their hosted link, TapResearch:
- Checks eligibility. TapResearch evaluates the user against available surveys. You don't make an eligibility call — it's handled on TapResearch's side.
- Redirects to a survey if the user qualifies for one. The user completes the survey within the TapResearch-hosted experience.
- Redirects to a "no surveys available" state if the user is not currently eligible for any survey. 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.