GuideAPI Reference

Getting Started with Usermaven REST API

Welcome to the Usermaven REST API documentation. This API allows you to interface with Usermaven servers, primarily for managing workspaces. Use it to create and manage analytics workspaces programmatically, ideal for B2B scenarios where you provide Usermaven analytics to your customers. For sending events, refer to our Client SDKs or server-side integrations.

A common use case is embedding Usermaven analytics into your SaaS platform: Create a workspace via the API, provide the embed code to your customers, and let them integrate it into their sites for access to dashboards.

To get started, you'll need an API key for authentication.

Creating an API Key

If you're integrating Usermaven into your SaaS or application to offer analytics, an API key is essential.

Step 1: Generate the API Key

  1. Navigate to Account Settings > API Credentials in your Usermaven account.

  2. Click Create a new API key.

  3. Assign a name to your key and click Generate API Key.

Once generated, securely store the key—it won't be shown again.

Step 2: Authenticate Requests

Authenticate by including the API key in the X-API-KEY header:

curl -X GET \
  https://api.usermaven.com/v2/workspaces \
  -H 'X-API-KEY: <YOUR_API_KEY>'

This example fetches your workspaces. Replace <YOUR_API_KEY> with your actual key.

What's Next?

With your API key ready, explore the full API endpoints in our Reference section. There, you'll find details on workspace management, event ingestion, and more.

For any questions or feedback, contact our support team.