About the User Event Export
About the Enduser Events APIs
The Enduser Events APIs let you export engagement data from your Userlane property in JSON format. Use them to bring guide and announcement engagement data into your BI tool (Power BI, Tableau, Looker, etc.) or combine it with data you collect in other systems.
Why use it
Use the data to:
- track how individual users engage with your Guides and Announcements
- measure onboarding completion across your user base
- enrich your internal reporting with Userlane engagement data
- share Userlane insights with a wider audience of stakeholders in your organisation
What you can export
There are three APIs in the Enduser Events family. Choose based on the question you want to answer:
| What percentage of my onboarding Guide is done by users? | Guide Progress API |
| Where do users drop off in a Guide? What was the most started Guide? | Guides API |
| How many users saw or clicked my Announcement? | Announcements API |
Guides API
Returns event-level records for every interaction with your Userlane Guides:
- Guide started — a user opened a guide
- Guide finished — a user reached the end of a guide
- Guide exited — a user closed a guide before finishing (includes the step they exited on)
For each event, you get the time, event type, user, guide ID, and (for exits) the step number and total step count.
Announcements API
Returns event-level records for every interaction with your Userlane Announcements:
- Announcement viewed — an announcement was shown to a user
- Announcement interacted — a user clicked a button or link inside an announcement
For each event, you get the time, event type, user, and announcement ID.
Guide Progress API
Returns the current completion state for a specific guide, per user — how far each user got, what percentage they completed, and when they last interacted with it. Also returns aggregate completion statistics across all users (e.g. how many users reached 20%, 40%, 60%, 80%, or 100% completion).
The results from all three APIs are exported in JSON format.
Resolving IDs to names
The APIs return Guide and Announcement IDs as numbers (for example, "id": "99067"). To make the exported data usable in a report or dashboard, you'll need to match these numeric IDs to their human-readable titles.
For Guides:
- Open the Guide Analytics page in the Userlane Portal and export the list to CSV. The export includes both Guide ID and title.
- Or, open the analytics page for a specific guide — the ID is visible in the URL.
For Announcements:
- Open the Announcement Analytics page in the Userlane Portal and export the list to CSV. The export includes both Announcement ID and title.
For Guide Progress:
- You need the Guide ID before making the request (it's a required parameter). Find it the same way as above.
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
The export 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
- 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
- Guide ID (Guide Progress only) — the ID of the guide you want progress data for
The API exports cover a maximum of 60 days of history per request. For longer history, schedule a daily or weekly pull into your own database.
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 or date format is outside of the allowed date range (for example, larger than 60 days)
- an invalid or expired authentication token
Review your parameters against this article. If the issue persists, please reach out to us.
