API Introduction

This guide provides details on the API endpoints for interfacing with Usermaven. Use this API for communication with the Usermaven server.

Server-side vs. client-side

For sending events to Usermaven, please consult the sections on Client SDKs and server-side integrations. Currently, Usermaven offers exclusive API access for Workspaces. This allows you to establish workspaces directly through the API.

An illustrative use case would be for B2B customers aiming to supply analytics via Usermaven to their clientele: they can create a workspace and hand over the Usermaven embed code to their customers. Once the code is integrated on the customer's website, the Usermaven website analytics dashboard becomes accessible within their own platform.

Getting started

In order to initiate the embedding of the Usermaven dashboard, your first step should be to generate an API key. See the Create API Key guide, then review the API Authentication documentation to learn how to authenticate your requests.