About the Analytics APIs
The Analytics APIs let you export HEART scores, NPS responses, Survey responses, and feature interaction data from your Userlane property in JSON format. Use them to bring Userlane analytics into your BI tool (Power BI, Tableau, Looker, etc.), enrich it with data you collect in other systems, and share insights with a wider audience of stakeholders in your organisation.
Why use it
Use the data to:
- track product experience health over time with HEART scores
- pull NPS and Survey responses into your reporting alongside other feedback channels
- measure feature adoption with Tags data
- combine Userlane analytics with your own user data (role, region, department) for segment-level insights
What you can export
There are four Analytics APIs. Choose based on the question you want to answer:
| What are my HEART scores? | HEART API |
| Who are my promoters and detractors? | NPS API |
| How satisfied are users with a specific feature or flow? | Surveys API |
| Which features are users actually clicking? | Tags API |
HEART API
Returns daily HEART scores for your application — the overall composite score plus the five individual letter scores (Happiness, Engagement, Adoption, Retention, Task Success), along with user and session counts.
Use it to track product experience health over time and identify which dimension (H, E, A, R, or T) is driving changes in the overall score.
NPS API
Returns individual responses to Net Promoter Score surveys — score (0–10), optional free-text comment, timestamp, and user ID. NPS responses are bucketed into Promoters (9–10), Passives (7–8), and Detractors (0–6).
Use it to track sentiment trends, identify champions and at-risk users, and mine free-text comments for themes.
Surveys API
Returns individual responses to custom in-app surveys — score (1–5), optional free-text comment, timestamp, and user ID. Unlike NPS, which asks one fixed question across your product, surveys can be scoped to specific moments or features.
To get the Survey results you will need to enter the Survey id that you can find in the Portal.
Tags API
Returns per-user, per tag, per-day interaction counts on tagged elements — buttons, links, or pages you've marked in the Userlane Portal as meaningful actions in your product.
Use it to measure feature adoption, identify power users, spot adoption gaps by segment, and track how usage of a specific feature changes over time.
The results from all four APIs are exported in JSON format.
Resolving IDs to names
Tags, Surveys, and NPS responses return numeric IDs in the API response, not names. To make the exported data usable in a report or dashboard, you'll need to match these IDs to their human-readable titles.
For Tags:
- Open the Tag Analytics page (/analytics/heart/task-success?section=tags) in the Userlane Portal and export the list to CSV. The export includes both Tag ID and name.
For Surveys and NPS:
- There can only be one NPS so you don't need to resolve the ID
- The Survey ID is required parameters in the API request. You can find them in the URL of the corresponding survey in the Userlane Portal.
Join the API export with the CSV lookup in your BI tool to display names instead of numeric IDs in your reports.
How to export the data
Generate your token
The API export is protected and requires authentication via an Authorization Token. You can generate your token in the Userlane Portal under Settings > API Token.
The token is generated for each Userlane Manager individually. You can regenerate it at any time using the same button in your Portal.
Run the request
Each API is available through our developer documentation, which includes a "Try it" button you can use to test a request directly in the browser:
Each request needs:
- Property ID — the individual Userlane ID of your application
- Survey ID (Surveys only) — the ID of the specific survey
- Start and End dates — the time span for the export, in the format
2026-04-01T00:00:00+00:00 - Page and Limit — up to 1,000 records per page. For larger results, request each page separately by changing the page number.
- Authentication token — paste your token into the Authentication field
Once the request runs successfully, you can copy the JSON response (or the request code) using the copy icon.
Troubleshooting
If the request fails, you'll see an error message in the result section. Most errors relate to:
- an incorrect date format
- an invalid or expired authentication token
Review your parameters against this article. If the issue persists, please reach out to us.
