UserLeap

The UserLeap Developer Hub

Welcome to the UserLeap developer hub. You'll find comprehensive guides and documentation to help you start working with UserLeap as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Guides

The UserLeap API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

UserLeap offers API access to both your Production and Development environments. You can use your Development environment to validate your usage of the UserLeap API before interacting with your live data. The API key you use to authenticate the request determines whether the request is against Production data or Development data. Team members with the Admin or Developer roles can see the API Keys.

This is an early version of the UserLeap Public API. We welcome your feedback and feature requests.

Find Your API Keys

  1. In the Navigation Pane click Connect.
  2. Click Public API.
  3. Click copy to copy a key.

Authentication

UserLeap uses API keys to authenticate requests to the Public API. Your API keys grant access to your data stored in UserLeap, so be sure to keep them secure! Do not share your API keys in publicly accessible areas such as GitHub or client-side code.

Authentication to the API is performed via the HTTP Authorization Header. Include this header on all requests to the API.

The header name is Authorization, and an example value is

API-Key 8abaf7cb-fake-fake-fake-c608317728bd

Using the command-line tool curl, you would use the following snippet to include the API key with a request.

curl https://api.userleap.com/v1/users/1234567890 \
 -H "Authorization: API-Key 8abaf7cb-fake-fake-fake-c608317728bd"

HTTP clients in all programming languages allow for custom headers to be set. If you need assistance using the UserLeap API with a specific language, please let us know.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Users

The User object defines a visitor in the UserLeap system that has registered on your site and their User Id has been provided by the SDK with the setUserIdentifier function. The API allows you to read and update the properties of individual users.

The user object

PropertyTypeDescription
idstringThe ID of the user in your system
emailAddressstringThe Email Address of the user
attributesmapA key-value map of custom attributes you can set on the user

Example User Object

{
  "userId": "1234567890",
  "emailAddress": "[email protected]",
  "attributes": {
    "plan_type": "standard"
  }
}

Rate Limiting

We currently limit 1000 requests per 5-minute interval for a given API Key.

If you need a higher limit, please reach out to [email protected]

Updated 20 days ago

APIs


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.