OpenPanel

https://openpanel.dev/docs
Admin
OpenPanel is an open-source, privacy-first analytics platform that combines product and web...
Tokens:102,417
Snippets:1,201
Trust Score:8.2
Update:1 week ago
Show doc for...
Tokens:
Raw
### Clone and start OpenPanel (quickstart)

Source: https://openpanel.dev/docs/self-hosting/self-hosting

Clones the self-hosting branch, enters the self-hosting directory, runs the setup script, and then starts OpenPanel with ./start.

```bash
git clone -b self-hosting https://github.com/Openpanel-dev/openpanel && cd openpanel/self-hosting && ./setup
# After setup is complete run `./start` to start OpenPanel
```

--------------------------------

### Run the setup script

Source: https://openpanel.dev/docs/self-hosting/deploy-docker-compose

Runs the interactive setup script that installs Node.js and Docker if needed, and guides through configuration questions. If it fails, manual setup is possible.

```bash
./setup
```

--------------------------------

### Run the setup script

Source: https://openpanel.dev/docs/self-hosting/self-hosting

Runs the setup script inside the self-hosting folder. The script installs node and docker (if accepted) and executes a node script that asks questions about your setup. Takes 30s to 2 minutes.

```bash
cd openpanel/self-hosting
./setup
```

--------------------------------

### Start all OpenPanel services

Source: https://openpanel.dev/docs/self-hosting/deploy-docker-compose

Starts all required OpenPanel services after setup is complete. This includes op-db, op-kv, op-ch, op-api, op-dashboard, and op-worker.

```bash
./start
```

--------------------------------

### Install @openpanel/web

Source: https://openpanel.dev/docs/sdks/vue

Install the OpenPanel web SDK for Vue projects.

```bash
pnpm install @openpanel/web
```

--------------------------------

### Install @openpanel/web with bun

Source: https://openpanel.dev/docs/sdks/web

Install the OpenPanel web SDK using bun.

```bash
bun add @openpanel/web
```

--------------------------------

### Install @openpanel/nextjs

Source: https://openpanel.dev/docs/sdks/nextjs

Install the OpenPanel Next.js SDK using pnpm.

```bash
pnpm install @openpanel/nextjs
```

--------------------------------

### Install @openpanel/sdk with bun

Source: https://openpanel.dev/docs/sdks/javascript

Install the OpenPanel JavaScript SDK using bun.

```bash
bun add @openpanel/sdk
```

--------------------------------

### Install @openpanel/web with yarn

Source: https://openpanel.dev/docs/sdks/web

Install the OpenPanel web SDK using yarn.

```bash
yarn add @openpanel/web
```

--------------------------------

### Installation

Source: https://openpanel.dev/docs/sdks/javascript

Install the @openpanel/sdk package using npm, pnpm, yarn, or bun.

```APIDOC
## Installation

### npm
```bash
npm install @openpanel/sdk
```

### pnpm
```bash
pnpm add @openpanel/sdk
```

### yarn
```bash
yarn add @openpanel/sdk
```

### bun
```bash
bun add @openpanel/sdk
```
```

--------------------------------

### Installation

Source: https://openpanel.dev/docs/sdks/nuxt

Install the @openpanel/nuxt package using pnpm.

```APIDOC
## Install Dependencies

### Description
Install the OpenPanel Nuxt SDK package.

### Command
```bash
pnpm install @openpanel/nuxt
```
```

--------------------------------

### Install @openpanel/web with npm

Source: https://openpanel.dev/docs/sdks/web

Install the OpenPanel web SDK using npm.

```bash
npm install @openpanel/web
```

--------------------------------

### Install @openpanel/astro

Source: https://openpanel.dev/docs/sdks/astro

Install the OpenPanel Astro SDK using pnpm.

```bash
pnpm install @openpanel/astro
```

--------------------------------

### Install @openpanel/web with pnpm

Source: https://openpanel.dev/docs/sdks/web

Install the OpenPanel web SDK using pnpm.

```bash
pnpm add @openpanel/web
```

--------------------------------

### Install @openpanel/sdk with npm

Source: https://openpanel.dev/docs/sdks/javascript

Install the OpenPanel JavaScript SDK using npm.

```bash
npm install @openpanel/sdk
```

--------------------------------

### Install @openpanel/sdk with yarn

Source: https://openpanel.dev/docs/sdks/javascript

Install the OpenPanel JavaScript SDK using yarn.

```bash
yarn add @openpanel/sdk
```

--------------------------------

### Install @openpanel/nuxt with pnpm

Source: https://openpanel.dev/docs/sdks/nuxt

Install the OpenPanel Nuxt module as a dependency.

```bash
pnpm install @openpanel/nuxt
```

--------------------------------

### Install @openpanel/sdk with pnpm

Source: https://openpanel.dev/docs/sdks/javascript

Install the OpenPanel JavaScript SDK using pnpm.

```bash
pnpm add @openpanel/sdk
```

--------------------------------

### Install @openpanel/express with pnpm

Source: https://openpanel.dev/docs/sdks/express

Install the OpenPanel Express SDK using pnpm.

```bash
pnpm install @openpanel/express
```

--------------------------------

### Install React Native dependencies with bun

Source: https://openpanel.dev/docs/sdks/react-native

Install @react-native-async-storage/async-storage and @react-native-community/netinfo using bun.

```bash
bun add @react-native-async-storage/async-storage @react-native-community/netinfo
```

--------------------------------

### Install gem directly

Source: https://openpanel.dev/docs/sdks/ruby

Installs the openpanel-sdk gem directly without Bundler.

```bash
gem install openpanel-sdk
```

--------------------------------

### Install @openpanel/web with npm, pnpm, yarn, or bun

Source: https://openpanel.dev/docs/sdks/script

Install the OpenPanel Web SDK using your preferred package manager. Choose the command for npm, pnpm, yarn, or bun.

```bash
npm install @openpanel/web
```

```bash
pnpm add @openpanel/web
```

```bash
yarn add @openpanel/web
```

```bash
bun add @openpanel/web
```

--------------------------------

### Install OpenPanel with values file

Source: https://openpanel.dev/docs/self-hosting/deploy-kubernetes

Installs the OpenPanel Helm chart with the specified version, namespace, and custom values file. Requires configured values to avoid failure.

```bash
helm install my-openpanel openpanel/openpanel \
  --version 0.1.0 \
  --namespace openpanel \
  --create-namespace \
  -f my-values.yaml
```

--------------------------------

### Install openpanel-sdk via cargo add

Source: https://openpanel.dev/docs/sdks/rust

Install the openpanel-sdk crate using the cargo add command.

```bash
cargo add openpanel-sdk
```

--------------------------------

### Install OpenPanel Python SDK

Source: https://openpanel.dev/docs/sdks/python

Install the OpenPanel Python SDK using pip.

```bash
pip install openpanel
```

--------------------------------

### Install React Native dependencies with pnpm

Source: https://openpanel.dev/docs/sdks/react-native

Install @react-native-async-storage/async-storage and @react-native-community/netinfo using pnpm.

```bash
pnpm add @react-native-async-storage/async-storage @react-native-community/netinfo
```

--------------------------------

### Install React Native dependencies with yarn

Source: https://openpanel.dev/docs/sdks/react-native

Install @react-native-async-storage/async-storage and @react-native-community/netinfo using yarn.

```bash
yarn add @react-native-async-storage/async-storage @react-native-community/netinfo
```

--------------------------------

### Install offline support dependencies

Source: https://openpanel.dev/docs/sdks/react-native

Install the optional peer dependencies for offline support. The SDK buffers events when offline and flushes them when connectivity is restored, stamping events with a __timestamp at fire time.

```bash
npm install @react-native-async-storage/async-storage @react-native-community/netinfo
```

```bash
pnpm add @react-native-async-storage/async-storage @react-native-community/netinfo
```

```bash
yarn add @react-native-async-storage/async-storage @react-native-community/netinfo
```

```bash
bun add @react-native-async-storage/async-storage @react-native-community/netinfo
```

--------------------------------

### GET /device, /browser, /os

Source: https://openpanel.dev/docs/api/insights

Retrieves device and technology breakdown for the project.

```APIDOC
## GET /device, /browser, /os

### Description
Retrieves device and technology breakdown for the project.

### Method
GET

### Endpoint
https://api.openpanel.dev/insights/{projectId}/device
https://api.openpanel.dev/insights/{projectId}/browser
https://api.openpanel.dev/insights/{projectId}/os

### Parameters
#### Query Parameters
- **startDate** (string) - Optional - Start date for the query.
- **endDate** (string) - Optional - End date for the query.
- **range** (string) - Optional - Predefined time range.
- **filters** (object) - Optional - Filters to apply.
- **cursor** (string) - Optional - Pagination cursor.
- **limit** (integer) - Optional - Maximum number of results.

### Response
#### Success Response (200)
- **breakdown** (array) - List of devices/browsers/OS with visitor counts.

#### Response Example
{
  "breakdown": [
    {
      "device": "desktop",
      "visitors": 800
    },
    {
      "device": "mobile",
      "visitors": 200
    }
  ]
}
```

--------------------------------

### GET /manage/projects

Source: https://openpanel.dev/docs/api/manage/projects

Lists all projects in your organization. Requires a root client.

```APIDOC
## GET /manage/projects

### Description
List all projects in your organization.

### Method
GET

### Endpoint
https://api.openpanel.dev/manage/projects

### Authentication
Requires a `root` client.

### Response
#### Success Response (200)
Returns a list of projects.

```

--------------------------------

### Verify pods

Source: https://openpanel.dev/docs/self-hosting/deploy-kubernetes

Lists all pods in the openpanel namespace to verify the installation.

```bash
kubectl get pods -n openpanel
```

--------------------------------

### Verify all required values are set

Source: https://openpanel.dev/docs/self-hosting/deploy-kubernetes

Get the values of the Helm release to check configuration.

```bash
helm get values my-openpanel -n openpanel
```

--------------------------------

### Basic operations with utility scripts

Source: https://openpanel.dev/docs/self-hosting/deploy-docker-compose

Shows the basic utility scripts for starting, stopping, and viewing logs for all OpenPanel services.

```bash
./start    # Start all OpenPanel services
./stop     # Stop all OpenPanel services
./logs     # View real-time logs from all services
```

--------------------------------

### API_PORT example

Source: https://openpanel.dev/docs/self-hosting/environment-variables

Sets the port for the API service to listen on. Default is 3000.

```bash
API_PORT=3000
```

--------------------------------

### PROFILE_BUFFER_TTL_IN_SECONDS example

Source: https://openpanel.dev/docs/self-hosting/environment-variables

Sets the time-to-live in seconds for profile buffer entries. Default is buffer-specific.

```bash
PROFILE_BUFFER_TTL_IN_SECONDS=3600
```

--------------------------------

### Check Docker and Docker Compose versions

Source: https://openpanel.dev/docs/self-hosting/deploy-docker-compose

Verify the installed versions of Docker and Docker Compose to help diagnose startup issues.

```bash
docker --version
docker compose version
```

--------------------------------

### Full configuration example for OpenPanel Java SDK

Source: https://openpanel.dev/docs/sdks/java

Configure all Java-specific options: apiUrl, disabled, filter, timeouts, retries, and verbose logging. The filter function can prevent tracking events that start with "debug_". Defaults: apiUrl is https://api.openpanel.dev, connectTimeoutSeconds=10, readTimeoutSeconds=30, maxRetries=3, initialRetryDelayMs=500.

```java
OpenPanel op = OpenPanel.create(
    OpenPanelOptions.builder()
        .clientId("YOUR_CLIENT_ID")
        .clientSecret("YOUR_CLIENT_SECRET")
        .apiUrl("https://api.openpanel.dev")
        .disabled(false)
        .filter(name -> !name.startsWith("debug_"))
        .connectTimeoutSeconds(10)
        .readTimeoutSeconds(30)
        .maxRetries(3)
        .initialRetryDelayMs(500)
        .verbose(false)
        .build()
);
```

--------------------------------

### DATABASE_URL - PostgreSQL connection string

Source: https://openpanel.dev/docs/self-hosting/environment-variables

Required for the main database. Example shows a PostgreSQL connection string with schema.

```bash
DATABASE_URL=postgres://user:password@localhost:5432/openpanel?schema=public
```

--------------------------------

### Initialize OpenPanel

Source: https://openpanel.dev/docs/sdks/javascript

Create a new OpenPanel instance with your client credentials.

```APIDOC
## Initialize OpenPanel

### Description
Creates a new OpenPanel client instance using your client ID and client secret.

### Method
Constructor

### Parameters
- **clientId** (string) - Required - Your OpenPanel client ID.
- **clientSecret** (string) - Required - Your OpenPanel client secret.

### Request Example
```js
import { OpenPanel } from '@openpanel/sdk';

const op = new OpenPanel({
  clientId: 'YOUR_CLIENT_ID',
  clientSecret: 'YOUR_CLIENT_SECRET',
});
```
```

--------------------------------

### Installing and initializing the OpenPanel Swift SDK

Source: https://openpanel.dev/docs/sdks/swift

Adds the OpenPanel Swift Package Manager dependency, imports the OpenPanel module, and initializes the SDK with your client ID and secret.

```swift
dependencies: [
    .package(url: "https://github.com/Openpanel-dev/swift-sdk")
]
```

```swift
import OpenPanel
```

```swift
OpenPanel.initialize(options: .init(
    clientId: "YOUR_CLIENT_ID",
    clientSecret: "YOUR_CLIENT_SECRET"
))
```

--------------------------------

### Clone the OpenPanel repository and navigate to self-hosting directory

Source: https://openpanel.dev/docs/self-hosting/deploy-docker-compose

Clones the OpenPanel repository using the self-hosting branch and changes into the self-hosting directory. This is the first step in the quick start workflow.

```bash
git clone -b self-hosting https://github.com/Openpanel-dev/openpanel.git
cd openpanel/self-hosting
```

--------------------------------

### Initialize OpenPanel instance (src/openpanel.ts)

Source: https://openpanel.dev/docs/sdks/react

Create a shared OpenPanel instance with clientId and tracking options. Configure trackScreenViews, trackOutgoingLinks, and trackAttributes as needed.

```ts
import { OpenPanel } from '@openpanel/web';

export const op = new OpenPanel({
  clientId: 'YOUR_CLIENT_ID',
  trackScreenViews: true,
  trackOutgoingLinks: true,
  trackAttributes: true,
});
```

--------------------------------

### Express middleware setup and event tracking

Source: https://openpanel.dev/docs/sdks/express

Sets up the OpenPanel middleware, appends the SDK to the request object as `req.op`, and tracks a 'sign-up' event. Includes commented-out options for `trackRequest` and `getProfileId`.

```ts
import express from 'express';

import createOpenpanelMiddleware from '@openpanel/express';

const app = express();

app.use(
  createOpenpanelMiddleware({
    clientId: 'xxx',
    clientSecret: 'xxx',
    // trackRequest(url) {
    //   return url.includes('/v1')
    // },
    // getProfileId(req) {
    //   return req.user.id
    // }
  })
);

app.get('/sign-up', (req, res) => {
  // track sign up events
  req.op.track('sign-up', {
    email: req.body.email,
  });
  res.send('Hello World');
});

app.listen(3000, () => {
  console.log('Server is running on http://localhost:3000');
});
```

--------------------------------

### GET /manage/projects/{id}

Source: https://openpanel.dev/docs/api/manage/projects

Get a specific project by its ID. Requires a root client.

```APIDOC
## GET /manage/projects/{id}

### Description
Get a specific project.

### Method
GET

### Endpoint
https://api.openpanel.dev/manage/projects/{id}

### Authentication
Requires a `root` client.

### Parameters
#### Path Parameters
- **id** (string) - Required - The project ID.

### Response
#### Success Response (200)
Returns the project details.

```

--------------------------------

### Initialize OpenPanel Java SDK

Source: https://openpanel.dev/docs/sdks/java

Import the SDK and initialize it with your client ID and secret. This is required before using any tracking methods.

```java
import fr.idcapture.openpanel.OpenPanel;
import fr.idcapture.openpanel.OpenPanelOptions;

OpenPanel op = OpenPanel.create(
    OpenPanelOptions.builder()
        .clientId("YOUR_CLIENT_ID")
        .clientSecret("YOUR_CLIENT_SECRET")
        .build()
);
```

--------------------------------

### GET /manage/clients/{id}

Source: https://openpanel.dev/docs/api/manage/clients

Get a specific client by its ID. Requires a root client for authentication.

```APIDOC
## GET /manage/clients/{id}

### Description
Get a specific client.

### Method
GET

### Endpoint
`/manage/clients/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - The client ID.

### Authentication
Requires a `root` client. See the [Authentication](/docs/api/authentication) guide.

### Response
#### Success Response (200)
- **client** (object) - The client object.

#### Response Example
```json
{
  "id": "string",
  "type": "write"
}
```
```

--------------------------------

### SSH into server

Source: https://openpanel.dev/docs/self-hosting/migrating-from-clerk

Connect to your server via SSH to run the migration commands.

```bash
ssh user@your-ip
```

--------------------------------

### Install OpenPanel with inline overrides

Source: https://openpanel.dev/docs/self-hosting/deploy-kubernetes

Installs the OpenPanel Helm chart while overriding specific values directly using --set flags. Generates a cookie secret with openssl.

```bash
helm install my-openpanel openpanel/openpanel \
  --version 0.1.0 \
  --namespace openpanel \
  --create-namespace \
  --set ingress.fqdn=your-domain.com \
  --set config.apiUrl=https://your-domain.com/api \
  --set secrets.cookieSecret=$(openssl rand -base64 32)
```

--------------------------------

### OpenPanel.create

Source: https://openpanel.dev/docs/sdks/java

Initializes the OpenPanel SDK with the provided options. Returns an OpenPanel instance for tracking events and managing user data.

```APIDOC
## OpenPanel.create

### Description
Initializes the OpenPanel SDK with the provided options. Returns an OpenPanel instance for tracking events and managing user data.

### Method
create

### Parameters
- **options** (OpenPanelOptions) - Required - Configuration options including clientId, clientSecret, apiUrl, disabled, filter, connectTimeoutSeconds, readTimeoutSeconds, maxRetries, initialRetryDelayMs, verbose.

### Request Example
```java
OpenPanel op = OpenPanel.create(
    OpenPanelOptions.builder()
        .clientId("YOUR_CLIENT_ID")
        .clientSecret("YOUR_CLIENT_SECRET")
        .build()
);
```

### Response
Returns an OpenPanel instance.
```

--------------------------------

### Disable Clickhouse user setup

Source: https://openpanel.dev/docs/migration/migrate-v1-to-v2

Add the CLICKHOUSE_SKIP_USER_SETUP environment variable to the op-ch service to avoid connection issues, as Clickhouse 25 enables default user setup by default.

```yaml
services:
  op-ch:
    environment:
      - CLICKHOUSE_SKIP_USER_SETUP=1
```

--------------------------------

### POST /manage/projects

Source: https://openpanel.dev/docs/api/manage/projects

Create a new project. A default write client is automatically created and returned with the response; the client secret is only shown once.

```APIDOC
## POST /manage/projects

### Description
Create a new project. A default `write` client is automatically created and returned with the response. The client secret is only shown once.

### Method
POST

### Endpoint
https://api.openpanel.dev/manage/projects

### Authentication
Requires a `root` client.

### Response
#### Success Response (200)
Returns the created project and the default write client with its secret.

```

--------------------------------

### Kotlin interop example

Source: https://openpanel.dev/docs/sdks/java

All property maps use JetBrains @Nullable type-use annotations, so Kotlin sees Map<String, Any?> natively. This example shows a track call with a map containing a nullable value.

```kotlin
op.track("checkout", mapOf("amount" to 49.99, "coupon" to null))
```

--------------------------------

### window.op('init')

Source: https://openpanel.dev/docs/sdks/script

Initializes the OpenPanel script tag with your client ID and optional tracking settings.

```APIDOC
## window.op('init')

### Description
Initializes the OpenPanel tracking with your client ID and optional settings for automatic tracking of screen views, outgoing links, and attributes.

### Method
`window.op('init', options)`

### Parameters
- `clientId` (string) - Required - Your client ID.
- `trackScreenViews` (boolean) - Optional - Automatically track screen views.
- `trackOutgoingLinks` (boolean) - Optional - Automatically track outgoing links.
- `trackAttributes` (boolean) - Optional - Automatically track data attributes.
- `filter` (function) - Optional - A function to filter out events. Return `true` to allow tracking, `false` to disable.

### Request Example
```html
<script>
  window.op('init', {
    clientId: 'YOUR_CLIENT_ID',
    trackScreenViews: true,
    trackOutgoingLinks: true,
    trackAttributes: true,
  });
</script>
```

### Response
No response. Initializes tracking.
```

--------------------------------

### GET /referrer

Source: https://openpanel.dev/docs/api/insights

Retrieves traffic sources for the project.

```APIDOC
## GET /referrer

### Description
Retrieves traffic sources for the project.

### Method
GET

### Endpoint
https://api.openpanel.dev/insights/{projectId}/referrer

### Parameters
#### Query Parameters
- **startDate** (string) - Optional - Start date for the query.
- **endDate** (string) - Optional - End date for the query.
- **range** (string) - Optional - Predefined time range.
- **filters** (object) - Optional - Filters to apply.
- **cursor** (string) - Optional - Pagination cursor.
- **limit** (integer) - Optional - Maximum number of results.

### Response
#### Success Response (200)
- **referrers** (array) - List of traffic sources with session counts.

#### Response Example
{
  "referrers": [
    {
      "source": "google.com",
      "sessions": 200
    },
    {
      "source": "direct",
      "sessions": 150
    }
  ]
}
```

--------------------------------

### Install dependencies with npm, pnpm, yarn, or bun

Source: https://openpanel.dev/docs/sdks/react-native

Install the OpenPanel React Native SDK and its peer dependencies (expo-application, expo-constants) using your preferred package manager. The SDK depends on these Expo modules for buildNumber, versionNumber, referrer (Android), and user-agent.

```bash
npm install @openpanel/react-native
npx expo install expo-application expo-constants
```

```bash
npm install @openpanel/react-native
pnpm dlx expo install expo-application expo-constants
```

```bash
npm install @openpanel/react-native
yarn dlx expo install expo-application expo-constants
```

```bash
npm install @openpanel/react-native
bun x expo install expo-application expo-constants
```

--------------------------------

### View logs from deployments (kubectl logs)

Source: https://openpanel.dev/docs/self-hosting/deploy-kubernetes

Shows how to tail logs from the API, dashboard, and worker deployments in the openpanel namespace.

```bash
# API logs
kubectl logs -f deployment/op-api -n openpanel

# Dashboard logs
kubectl logs -f deployment/op-dashboard -n openpanel

# Worker logs
kubectl logs -f deployment/op-worker -n openpanel
```

--------------------------------

### GET /pages

Source: https://openpanel.dev/docs/api/insights

Retrieves the top pages by sessions for the project.

```APIDOC
## GET /pages

### Description
Retrieves the top pages by sessions for the project.

### Method
GET

### Endpoint
https://api.openpanel.dev/insights/{projectId}/pages

### Parameters
#### Query Parameters
- **startDate** (string) - Optional - Start date for the query.
- **endDate** (string) - Optional - End date for the query.
- **range** (string) - Optional - Predefined time range.
- **filters** (object) - Optional - Filters to apply.
- **cursor** (string) - Optional - Pagination cursor.
- **limit** (integer) - Optional - Maximum number of results.

### Response
#### Success Response (200)
- **pages** (array) - List of top pages with session counts.

#### Response Example
{
  "pages": [
    {
      "path": "/home",
      "sessions": 100
    },
    {
      "path": "/about",
      "sessions": 50
    }
  ]
}
```

--------------------------------

### GET /manage/references/{id}

Source: https://openpanel.dev/docs/api/manage/references

Retrieves a specific reference by its ID.

```APIDOC
## GET /manage/references/{id}

### Description
Get a specific reference by its ID.

### Method
GET

### Endpoint
https://api.openpanel.dev/manage/references/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the reference.

### Response
#### Success Response (200)
- **reference** (object) - The reference object.

#### Response Example
{
  "reference": {}
}
```

--------------------------------

### GET /manage/references

Source: https://openpanel.dev/docs/api/manage/references

Lists all references, optionally filtered by projectId.

```APIDOC
## GET /manage/references

### Description
Lists all references, optionally filtered by projectId.

### Method
GET

### Endpoint
https://api.openpanel.dev/manage/references

### Parameters
#### Query Parameters
- **projectId** (string) - Optional - Filter references by project ID.

### Response
#### Success Response (200)
- **references** (array) - List of reference objects.

#### Response Example
{
  "references": []
}
```

--------------------------------

### Require and initialize the SDK

Source: https://openpanel.dev/docs/sdks/ruby

Requires the openpanel-sdk gem and creates a new Tracker instance.

```ruby
require 'openpanel-sdk'

tracker = OpenPanel::SDK::Tracker.new
```

--------------------------------

### View all services

Source: https://openpanel.dev/docs/self-hosting/deploy-kubernetes

List all services in the openpanel namespace.

```bash
kubectl get svc -n openpanel
```

--------------------------------

### GET /live

Source: https://openpanel.dev/docs/api/insights

Retrieves the current active visitor count for the project.

```APIDOC
## GET /live

### Description
Retrieves the current active visitor count for the project.

### Method
GET

### Endpoint
https://api.openpanel.dev/insights/{projectId}/live

### Parameters
#### Query Parameters
- **startDate** (string) - Optional - Start date for the query.
- **endDate** (string) - Optional - End date for the query.
- **range** (string) - Optional - Predefined time range.
- **filters** (object) - Optional - Filters to apply.
- **cursor** (string) - Optional - Pagination cursor.
- **limit** (integer) - Optional - Maximum number of results.

### Response
#### Success Response (200)
- **activeVisitors** (integer) - Current active visitor count.

#### Response Example
{
  "activeVisitors": 42
}
```

--------------------------------

### Initialize the OpenPanel Rust SDK

Source: https://openpanel.dev/docs/sdks/rust

Import and initialize the OpenPanel SDK using Tracker::try_new_from_env() and with_default_headers().

```rust
use openpanel_sdk::sdk::Tracker;

let tracker = Tracker::try_new_from_env()?.with_default_headers()?;
```

--------------------------------

### Initialize OpenPanel Python SDK

Source: https://openpanel.dev/docs/sdks/python

Import and initialize the OpenPanel SDK with your client ID and client secret.

```python
from openpanel import OpenPanel

op = OpenPanel(
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET"
)
```

--------------------------------

### GET /utm_source, /utm_campaign, …

Source: https://openpanel.dev/docs/api/insights

Retrieves UTM parameter breakdown for the project.

```APIDOC
## GET /utm_source, /utm_campaign, …

### Description
Retrieves UTM parameter breakdown for the project.

### Method
GET

### Endpoint
https://api.openpanel.dev/insights/{projectId}/utm_source
https://api.openpanel.dev/insights/{projectId}/utm_campaign

### Parameters
#### Query Parameters
- **startDate** (string) - Optional - Start date for the query.
- **endDate** (string) - Optional - End date for the query.
- **range** (string) - Optional - Predefined time range.
- **filters** (object) - Optional - Filters to apply.
- **cursor** (string) - Optional - Pagination cursor.
- **limit** (integer) - Optional - Maximum number of results.

### Response
#### Success Response (200)
- **breakdown** (array) - List of UTM values with visitor counts.

#### Response Example
{
  "breakdown": [
    {
      "utm_source": "newsletter",
      "visitors": 100
    },
    {
      "utm_source": "social",
      "visitors": 50
    }
  ]
}
```

--------------------------------

### Check all resources

Source: https://openpanel.dev/docs/self-hosting/deploy-kubernetes

Lists all resources in the openpanel namespace to check the status of the deployment.

```bash
kubectl get all -n openpanel
```

--------------------------------

### Enable Google OAuth (secrets.googleClientId, secrets.googleClientSecret)

Source: https://openpanel.dev/docs/self-hosting/deploy-kubernetes

Configures Google OAuth credentials for login. Requires setting up OAuth in Google Cloud Console and adding the redirect URI https://your-domain.com/api/oauth/google/callback.

```yaml
secrets:
  googleClientId: "xxxxx.apps.googleusercontent.com"
  googleClientSecret: "GOCSPX-xxxxxxxxxxxxx"
```

--------------------------------

### Troubleshooting: Check events

Source: https://openpanel.dev/docs/self-hosting/deploy-kubernetes

Get events sorted by last timestamp to diagnose issues.

```bash
kubectl get events --sort-by='.lastTimestamp' -n openpanel
```

--------------------------------

### Use composable in component

Source: https://openpanel.dev/docs/sdks/vue

Use the composable to get the OpenPanel instance and track an event.

```vue
<script setup>
import { useOpenPanel } from '@/composables/useOpenPanel';

const op = useOpenPanel();
op.track('my_event', { foo: 'bar' });
</script>
```

--------------------------------

### MCP Tools - Project Access

Source: https://openpanel.dev/docs/mcp

Tools for listing projects and getting dashboard URLs.

```APIDOC
## MCP Tools - Project Access

### Tool: list_projects
List all projects accessible with your credentials. Root clients see all organization projects; read clients see only their own.

### Tool: get_dashboard_urls
Get clickable dashboard links for the current project — overview, events, profiles, sessions, and deep-links to specific items.
```

--------------------------------

### Troubleshooting: Check logs

Source: https://openpanel.dev/docs/self-hosting/deploy-kubernetes

View logs for a specific pod.

```bash
kubectl logs <pod-name> -n openpanel
```

--------------------------------

### GET /metrics

Source: https://openpanel.dev/docs/api/insights

Retrieves visitors, sessions, bounce rate, and engagement metrics for the project.

```APIDOC
## GET /metrics

### Description
Retrieves visitors, sessions, bounce rate, and engagement metrics for the project.

### Method
GET

### Endpoint
https://api.openpanel.dev/insights/{projectId}/metrics

### Parameters
#### Query Parameters
- **startDate** (string) - Optional - Start date for the query.
- **endDate** (string) - Optional - End date for the query.
- **range** (string) - Optional - Predefined time range.
- **filters** (object) - Optional - Filters to apply.
- **cursor** (string) - Optional - Pagination cursor.
- **limit** (integer) - Optional - Maximum number of results.

### Response
#### Success Response (200)
- **visitors** (integer) - Number of visitors.
- **sessions** (integer) - Number of sessions.
- **bounceRate** (number) - Bounce rate percentage.
- **engagement** (number) - Engagement metric.

#### Response Example
{
  "visitors": 1234,
  "sessions": 5678,
  "bounceRate": 45.6,
  "engagement": 78.9
}
```

--------------------------------

### IMPORT_BATCH_SIZE example

Source: https://openpanel.dev/docs/self-hosting/environment-variables

Sets the batch size for data import operations. Default is 5000.

```bash
IMPORT_BATCH_SIZE=10000
```

--------------------------------

### Use the provided logs script

Source: https://openpanel.dev/docs/self-hosting/deploy-docker-compose

Runs the provided logs script to view real-time logs from all services.

```bash
./logs
```

--------------------------------

### ALLOW_REGISTRATION - Enable public registration

Source: https://openpanel.dev/docs/self-hosting/environment-variables

Set to true to enable public registration. Registration is automatically disabled after the first user is created; set to true to re-enable.

```bash
ALLOW_REGISTRATION=true
```

--------------------------------

### Initialize OpenPanel SDK with client ID and secret

Source: https://openpanel.dev/docs/sdks/kotlin

Imports the OpenPanel SDK and creates an instance with your client ID and client secret. The context is an Android Context required for initialization.

```kotlin
import dev.openpanel.OpenPanel

val op = OpenPanel.create(
    context,
    OpenPanel.Options(
        clientId = "YOUR_CLIENT_ID",
        clientSecret = "YOUR_CLIENT_SECRET"
    )
)
```

--------------------------------

### PROFILE_BUFFER_CHUNK_SIZE example

Source: https://openpanel.dev/docs/self-hosting/environment-variables

Sets the chunk size for profile buffer operations. Default is buffer-specific.

```bash
PROFILE_BUFFER_CHUNK_SIZE=1000
```

--------------------------------

### Check logs for errors

Source: https://openpanel.dev/docs/self-hosting/deploy-docker-compose

View the logs of all services to identify errors preventing startup.

```bash
docker compose logs
```

--------------------------------

### PROFILE_BUFFER_BATCH_SIZE example

Source: https://openpanel.dev/docs/self-hosting/environment-variables

Sets the batch size for profile buffer operations. Default is buffer-specific.

```bash
PROFILE_BUFFER_BATCH_SIZE=5000
```
Tokens:
Raw