Your Userlane API token is a single credential that lets you move data between Userlane and your own systems programmatically, without doing it by hand in the Portal. One token covers everything the API can do, both reading data out of Userlane and pushing data in.
This article explains what the token is for at a high level. Each linked article below covers one task in detail.
What you can do with it
The API token gives you access to two kinds of operation.
Export data out of Userlane. Pull your Userlane data into your own tools (a BI dashboard, a data warehouse, or an internal report). You can export:
- Guide, Guide progress, and Announcement events: how users interact with your in-app content.
- HEART, NPS, Survey, and Tags data: analytics and feedback.
- User profile data: details and attributes on your end-users.
Push data into Userlane. Send data from your own systems into Userlane so your content can use it. Today this covers:
- User attributes: push attributes (such as role, region, or licence type) from any system, so you can segment and target your Userlane content on data Userlane doesn't collect itself.
Generating your token
Generate your token in the Userlane Portal under Settings > API Token.
💡 The token is generated for each Userlane Manager individually. You can generate a new one at any time using the same button in your Portal. Generating a new token replaces the old one, so any integration using the previous token will need to be updated.
Who this is for
Working with the API requires technical knowledge, so the assistance of a developer is recommended. As an admin, you generate and manage the token; your developer uses it to build the integration.
A note on access
Some operations require the token's Manager to have admin rights — pushing user attributes, for example, requires a company admin. If an integration returns a permission error, check that the token belongs to a Manager with the right level of access.
