🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.
Enhance user identification and API documentation
Bill Yang9a55ee45bb85
diff --git a/docs/content/docs/api/getting-started.mdx b/docs/content/docs/api/getting-started.mdxindex b693ac32a..a0816fc6e 100644--- a/docs/content/docs/api/getting-started.mdx+++ b/docs/content/docs/api/getting-started.mdx@@ -3,6 +3,7 @@ title: Getting Starteddescription: Authentication, common parameters, and best practices for the Rybbit Stats API---+import { Callout } from 'fumadocs-ui/components/callout';import { TypeTable } from 'fumadocs-ui/components/type-table';import { Tab, Tabs } from 'fumadocs-ui/components/tabs';@@ -10,6 +11,18 @@ import { Tab, Tabs } from 'fumadocs-ui/components/tabs';The API is currently in beta. There may be breaking changes as we continue to improve and expand the API.</Callout>+## API Playground++The easiest way to explore and test the API is using the built-in **API Playground** in your Rybbit dashboard. Access it by navigating to any site and clicking "API Playground" in the sidebar.++The playground provides:+- **Endpoint browser** - Browse all available API endpoints+- **Parameter controls** - Configure request parameters with a visual interface+- **Live responses** - See real API responses with your actual data+- **Code generation** - Copy ready-to-use code snippets++This is the recommended way to familiarize yourself with the API before integrating it into your applications.+## AuthenticationAll API requests must include authentication using one of the following methods:diff --git a/docs/content/docs/identify-users.mdx b/docs/content/docs/identify-users.mdxindex 2f66ed852..0cf67c5ca 100644--- a/docs/content/docs/identify-users.mdx+++ b/docs/content/docs/identify-users.mdx@@ -9,6 +9,8 @@ User identification involves processing personal data. Before using these featurRybbit allows you to identify logged-in users and associate their activity with a persistent identity across devices and sessions. This enables powerful user-level analytics, including tracking user journeys, understanding retention, and personalizing experiences.++## How It WorksBy default, Rybbit assigns an anonymous ID to each visitor based on their device fingerprint. When you call `identify()`, you link this anonymous visitor to a known user ID, allowing you to:diff --git a/docs/public/docs/users.png b/docs/public/docs/users.pngnew file mode 100644index 000000000..db0a1ab55Binary files /dev/null and b/docs/public/docs/users.png differ