Rybbit

https://rybbit.com/docs
Admin
Rybbit is an open source web and product analytics platform that tracks events and user behavior...
Tokens:279,971
Snippets:3,010
Trust Score:8.1
Update:1 month ago
Show doc for...
Tokens:
Raw
### Setup Script Examples

Source: https://rybbit.com/docs/self-hosting-guides/self-hosting-advanced

Common usage patterns for the setup script, including Mapbox token configuration and custom port assignments.

```bash
# With Mapbox token
./setup.sh tracking.example.com --mapbox-token YOUR_MAPBOX_TOKEN

# Custom ports with built-in webserver
./setup.sh tracking.example.com --backend-port 8080 --client-port 8081

# Custom ports with your own webserver
./setup.sh tracking.example.com --no-webserver --backend-port 8080 --client-port 8081
```

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

### Run the Setup Script

Source: https://rybbit.com/docs/self-hosting

Execute the setup script with your domain name to configure environment variables and start the application.

```bash
./setup.sh your.domain.name
```

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

### Start development server

Source: https://rybbit.com/docs/proxy-guide/astro

Run the development server to verify the setup.

```bash
npm run dev
```

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

### Start services without webserver

Source: https://rybbit.com/docs/managing-your-installation

Starts services when the installation was configured without a webserver.

```bash
docker compose up -d
```

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

### Get Organizations Go Request

Source: https://rybbit.com/docs/api/organizations/list

Example request using the net/http package.

```go
req, _ := http.NewRequest("GET", "https://app.rybbit.io/api/organizations", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")

client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

var data []map[string]interface{}
json.NewDecoder(resp.Body).Decode(&data)
```

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

### Get User ID Example

Source: https://rybbit.com/docs/sdks/web

Example of retrieving and logging the current user ID.

```javascript
let currentUserId = rybbit.getUserId();
console.log("Current Rybbit User ID:", currentUserId);
```

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

### Get Site Go Request

Source: https://rybbit.com/docs/api/sites/get

Example request using the Go standard library.

```go
req, _ := http.NewRequest("GET", "https://app.rybbit.io/api/sites/123", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")

client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

var data map[string]interface{}
json.NewDecoder(resp.Body).Decode(&data)
```

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

### Initialize Rybbit SDK

Source: https://rybbit.com/docs/sdks/web

Example of initializing the SDK with the required analyticsHost and siteId. This must be called before any other tracking methods.

```javascript
import rybbit from "@rybbit/js";

await rybbit.init({
  analyticsHost: "https://app.rybbit.io/api",
  siteId: "1",
});
```

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

### Get Metric Response Example

Source: https://rybbit.com/docs/api/overview/metric

Example JSON response structure for the Get Metric endpoint.

```json
{
  "data": {
    "data": [
      {
        "value": "US",
        "count": 8420,
        "percentage": 54.63,
        "pageviews": 26891,
        "pageviews_percentage": 54.96,
        "bounce_rate": 41.2
      },
      {
        "value": "GB",
        "count": 2150,
        "percentage": 13.95,
        "pageviews": 6847,
        "pageviews_percentage": 13.99,
        "bounce_rate": 43.8
      }
    ],
    "totalCount": 87
  }
}
```

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

### Get Sessions Go Request

Source: https://rybbit.com/docs/api/sessions/list

Example request using the net/http package in Go.

```go
req, _ := http.NewRequest("GET", "https://app.rybbit.io/api/sites/1/sessions?page=1&limit=20&start_date=2024-01-01&end_date=2024-01-31", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")

client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

var data map[string]interface{}
json.NewDecoder(resp.Body).Decode(&data)
```

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

### Example Initialization

Source: https://rybbit.com/docs/sdks/react-native

Initialize the SDK with required and optional configuration options, including the storage adapter.

```javascript
import AsyncStorage from "@react-native-async-storage/async-storage";
import rybbit from "@rybbit/react-native";

await rybbit.init({
  analyticsHost: "https://app.rybbit.io/api",
  siteId: "1",
  appIdentifier: "com.example.app",
  appVersion: "1.4.2",
  storage: AsyncStorage,
  initialScreenName: "Home",
});
```

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

### Get Users Response Example

Source: https://rybbit.com/docs/api/users/list

The JSON structure returned by the Get Users endpoint.

```json
{
  "data": [
    {
      "user_id": "abc123def456",
      "identified_user_id": "user@example.com",
      "traits": {
        "plan": "pro",
        "company": "Acme Inc"
      },
      "country": "US",
      "region": "California",
      "city": "San Francisco",
      "language": "en-US",
      "browser": "Chrome",
      "operating_system": "macOS",
      "device_type": "desktop",
      "pageviews": 156,
      "events": 23,
      "sessions": 12,
      "hostname": "example.com",
      "first_seen": "2024-01-15T10:30:00.000Z",
      "last_seen": "2024-01-31T14:22:00.000Z"
    }
  ],
  "totalCount": 1247,
  "page": 1,
  "pageSize": 10
}
```

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

### Get Teams Response Example

Source: https://rybbit.com/docs/api/teams/list

The JSON structure returned by the Get Teams endpoint.

```json
{
  "teams": [
    {
      "id": "team_xyz789",
      "name": "Marketing",
      "organizationId": "org_abc123",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-02-20T14:15:00.000Z",
      "members": [
        {
          "userId": "user_123",
          "userName": "John Doe",
          "userEmail": "john@example.com"
        }
      ],
      "sites": [
        {
          "siteId": 123,
          "domain": "example.com",
          "name": "Example Site"
        }
      ]
    }
  ]
}
```

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

### Page Change Callback Examples

Source: https://rybbit.com/docs/sdks/web

Examples of registering callbacks for page changes and managing multiple listeners.

```javascript
// Register a callback
const unsubscribe = rybbit.onPageChange((newPath, previousPath) => {
  console.log(`Navigated from ${previousPath} to ${newPath}`);

  // Example: Track scroll position reset
  window.scrollTo(0, 0);
});

// Later, to remove the callback
unsubscribe();

// Example: Multiple callbacks can be registered
rybbit.onPageChange((newPath) => {
  // Update page title
  document.title = `${newPath} - My Site`;
});

rybbit.onPageChange((newPath, previousPath) => {
  // Log navigation for debugging
  if (process.env.NODE_ENV === 'development') {
    console.log('Navigation:', { from: previousPath, to: newPath });
  }
});
```

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

### Get Overview Response Example

Source: https://rybbit.com/docs/api/overview/overview

The JSON structure returned by the Get Overview endpoint.

```json
{
  "data": {
    "sessions": 15420,
    "pageviews": 48933,
    "users": 12847,
    "pages_per_session": 3.17,
    "bounce_rate": 42.8,
    "session_duration": 182.5
  }
}
```

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

### Rybbit SDK Configuration Example

Source: https://rybbit.com/docs/sdks/node

Example of initializing the Rybbit client with required configuration options.

```javascript
import { Rybbit } from "@rybbit/node";

const rybbit = new Rybbit({
  analyticsHost: "https://app.rybbit.io/api",
  siteId: "1",
  apiKey: "your-secret-api-key",
});
```

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

### Start services with webserver

Source: https://rybbit.com/docs/managing-your-installation

Starts services using the webserver profile.

```bash
docker compose --profile with-webserver up -d
```

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

### Get Funnels Response Example

Source: https://rybbit.com/docs/api/funnels/list

The JSON structure returned by the Get Funnels endpoint.

```json
{
  "data": [
    {
      "id": 1,
      "name": "Signup Funnel",
      "steps": [
        { "type": "page", "value": "/", "name": "Homepage" },
        { "type": "page", "value": "/pricing", "name": "Pricing" },
        { "type": "page", "value": "/signup", "name": "Signup" },
        { "type": "page", "value": "/signup/complete", "name": "Complete" }
      ],
      "createdAt": "2024-01-10T12:00:00.000Z",
      "updatedAt": "2024-01-15T09:30:00.000Z"
    }
  ]
}
```

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

### Complete script configuration example

Source: https://rybbit.com/docs/script

A comprehensive example demonstrating site ID, URL patterns for skipping or masking, debounce settings, and various replay-specific configurations.

```html
<script
  src="https://app.rybbit.io/api/script.js"
  defer
  data-site-id="456"
  data-skip-patterns='["/admin/**", "/preview/*"]'
  data-mask-patterns='["/users/*/profile", "/orders/**"]'
  data-debounce="300"
  data-replay-block-selector=".sensitive-content"
  data-replay-mask-text-selectors='[".user-name", "#email"]'
  data-replay-mask-all-inputs="true"
  data-replay-collect-fonts="false"
  data-replay-sampling='{"mousemove":false,"scroll":500}'
></script>
```

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

### Get Journeys Response Example

Source: https://rybbit.com/docs/api/insights/journeys

Example JSON response containing a list of user journeys.

```json
{
  "journeys": [
    {
      "path": ["/", "/pricing", "/signup"],
      "count": 1250,
      "percentage": 8.12
    },
    {
      "path": ["/", "/features", "/pricing", "/signup"],
      "count": 890,
      "percentage": 5.78
    },
    {
      "path": ["/blog/getting-started", "/", "/pricing"],
      "count": 650,
      "percentage": 4.22
    },
    {
      "path": ["/", "/docs", "/docs/quickstart"],
      "count": 580,
      "percentage": 3.77
    },
    {
      "path": ["/", "/about", "/contact"],
      "count": 420,
      "percentage": 2.73
    }
  ]
}
```

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

### Run the Setup Script with Mapbox Token

Source: https://rybbit.com/docs/self-hosting

Execute the setup script with the optional Mapbox token flag to enable 3D map visualizations.

```bash
./setup.sh your.domain.name --mapbox-token YOUR_MAPBOX_TOKEN
```

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

### Setup Script Usage

Source: https://rybbit.com/docs/self-hosting-guides/self-hosting-advanced

Basic syntax for executing the Rybbit setup script.

```bash
./setup.sh <domain_name> [options]
```

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

### Get Goal Sessions Response Example

Source: https://rybbit.com/docs/api/goals/sessions

Example JSON response structure for the goal sessions endpoint.

```json
{
  "data": [
    {
      "session_id": "sess_abc123",
      "user_id": "user_xyz789",
      "country": "US",
      "browser": "Chrome",
      "operating_system": "macOS",
      "device_type": "desktop",
      "entry_page": "/",
      "exit_page": "/signup/complete",
      "pageviews": 5,
      "session_duration": 245,
      "session_start": "2024-01-31T14:00:00.000Z",
      "session_end": "2024-01-31T14:04:05.000Z",
      "referrer": "https://google.com",
      "channel": "organic"
    }
  ]
}
```

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

### Install Netlify adapter

Source: https://rybbit.com/docs/proxy-guide/astro

Install the Netlify adapter package for deployment.

```bash
npm install @astrojs/netlify
```

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

### Get Event Names Response Example

Source: https://rybbit.com/docs/api/events/names

The JSON structure returned by the Get Event Names endpoint.

```json
{
  "data": [
    {
      "eventName": "signup",
      "count": 1250
    },
    {
      "eventName": "purchase",
      "count": 320
    },
    {
      "eventName": "add_to_cart",
      "count": 890
    },
    {
      "eventName": "newsletter_subscribe",
      "count": 456
    }
  ]
}
```

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

### Create Site Go Request

Source: https://rybbit.com/docs/api/organizations/create-site

Example request using the standard net/http library in Go.

```go
organizationId := "org_123"
body := bytes.NewBuffer([]byte(`{
  "domain": "example.com",
  "name": "My Website",
  "blockBots": true
}`))
req, _ := http.NewRequest("POST", "https://app.rybbit.io/api/organizations/"+organizationId+"/sites", body)
req.Header.Set("Authorization", "Bearer your_api_key_here")
req.Header.Set("Content-Type", "application/json")

client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

var data map[string]interface{}
json.NewDecoder(resp.Body).Decode(&data)
```

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

### Programmatic event tracking examples

Source: https://rybbit.com/docs/sdks/web

Examples showing how to track simple button clicks and complex cart additions with properties using JavaScript.

```javascript
// Track a simple button click
document.getElementById("cta-button")?.addEventListener("click", () => {
  rybbit.event("cta_click");
});

// Track adding an item to a shopping cart with properties
function addToCart(item) {
  // ... add item ...
  rybbit.event("add_to_cart", {
    itemId: item.id,
    itemName: item.name,
    price: item.price,
    quantity: 1
  });
}
```

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

### Get User Trait Values Response Example

Source: https://rybbit.com/docs/api/user-traits/values

Example JSON response structure for the trait values endpoint.

```json
{
  "values": [
    { "value": "pro", "userCount": 340 },
    { "value": "free", "userCount": 900 }
  ],
  "total": 2,
  "hasMore": false
}
```

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

### Run Rybbit Setup with Custom Ports

Source: https://rybbit.com/docs/self-hosting-guides/custom-nginx

Commands to initialize the Rybbit setup script with custom backend and client ports, optionally including a Mapbox token.

```bash
./setup.sh your.domain.name --no-webserver --backend-port 8080 --client-port 8081

# With Mapbox token
./setup.sh your.domain.name --no-webserver --backend-port 8080 --client-port 8081 --mapbox-token YOUR_MAPBOX_TOKEN
```

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

### Set Traits Example

Source: https://rybbit.com/docs/sdks/web

Example of updating user traits after an upgrade.

```javascript
// Update user traits after they upgrade
rybbit.setTraits({
  plan: "enterprise",
  upgradeDate: "2024-03-01"
});
```

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

### Get Session Replays Response Example

Source: https://rybbit.com/docs/api/session-replay/list

Example JSON response body containing a list of session replays.

```json
{
  "data": [
    {
      "session_id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "user_id": "dev_xyz789",
      "identified_user_id": "user@example.com",
      "start_time": "2024-01-31T14:00:00.000Z",
      "end_time": "2024-01-31T14:00:48.200Z",
      "duration_ms": 48200,
      "page_url": "/",
      "event_count": 312,
      "country": "US",
      "region": "California",
      "city": "San Francisco",
      "browser": "Chrome",
      "browser_version": "120.0.0",
      "operating_system": "macOS",
      "operating_system_version": "14.2",
      "device_type": "desktop",
      "screen_width": 1920,
      "screen_height": 1080
    }
  ]
}
```

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

### Install Rybbit React Native SDK

Source: https://rybbit.com/docs/sdks/react-native

Install the SDK and the recommended storage adapter.

```bash
npm install @rybbit/react-native @react-native-async-storage/async-storage
```

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

### Start Server with Nodemon

Source: https://rybbit.com/docs/proxy-guide/express

Install and use nodemon for development to automatically restart the server on changes.

```bash
npm install -D nodemon
npx nodemon server.js
```

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

### Go Request for Performance Overview

Source: https://rybbit.com/docs/api/performance/overview

Example request using Go's net/http package.

```go
req, _ := http.NewRequest("GET", "https://app.rybbit.io/api/sites/1/performance/overview?start_date=2024-01-01&end_date=2024-01-31", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")

client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

var data map[string]interface{}
json.NewDecoder(resp.Body).Decode(&data)
```

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

### Get Session Response Example

Source: https://rybbit.com/docs/api/sessions/get

The JSON structure returned by the API.

```json
{
  "data": {
    "session": {
      "session_id": "sess_abc123",
      "user_id": "dev_xyz789",
      "country": "US",
      "browser": "Chrome",
      "operating_system": "macOS",
      "device_type": "desktop",
      "session_start": "2024-01-31T14:00:00.000Z",
      "session_end": "2024-01-31T14:04:05.000Z",
      "session_duration": 245,
      "pageviews": 5,
      "events": 7,
      "entry_page": "/",
      "exit_page": "/pricing"
    },
    "events": [
      {
        "timestamp": "2024-01-31T14:00:00.000Z",
        "pathname": "/",
        "hostname": "example.com",
        "page_title": "Home",
        "type": "pageview",
        "referrer": "https://google.com"
      },
      {
        "timestamp": "2024-01-31T14:01:30.000Z",
        "pathname": "/",
        "hostname": "example.com",
        "type": "custom_event",
        "event_name": "cta_click",
        "props": { "button": "hero" }
      }
    ],
    "pagination": {
      "total": 7,
      "limit": 50,
      "offset": 0,
      "hasMore": false
    }
  }
}
```

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

### Install rrweb peer dependency with npm

Source: https://rybbit.com/docs/sdks/web

Install the optional rrweb dependency required for session replay functionality using npm.

```bash
npm install rrweb
```

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

### Identify User Example

Source: https://rybbit.com/docs/sdks/web

Examples of identifying a user with just an ID or with additional traits.

```javascript
// After a user logs in
rybbit.identify("user-xzy-123");

// With traits
rybbit.identify("user-xzy-123", {
  email: "user@example.com",
  plan: "premium",
  signupDate: "2024-01-15"
});
```

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

### Install rrweb peer dependency with yarn

Source: https://rybbit.com/docs/sdks/web

Install the optional rrweb dependency required for session replay functionality using yarn.

```bash
yarn add rrweb
```

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

### Manual pageview tracking examples

Source: https://rybbit.com/docs/sdks/web

Examples of manual pageview tracking, including standard calls, tracking modal steps, and virtual paths with query parameters.

```javascript
// Standard manual pageview (usually not needed if auto-tracking is on)
rybbit.pageview();

// Example: Track a step within a multi-step modal
function openUserDetailsModal(userId, step) {
  // ... logic to open and display the modal step ...
  rybbit.pageview(`/users/${userId}/modal/${step}`);
}
openUserDetailsModal("user-abc", "contact-info");

// Example: Track a virtual pageview with its own query parameters
function showFilteredProductList(category, sortBy) {
   let virtualPathWithQuery = `/products/category/${category}?sort=${sortBy}&view=grid`;
   rybbit.pageview(virtualPathWithQuery);
}
showFilteredProductList("electronics", "price_desc");
```

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

### Get Users .NET Request

Source: https://rybbit.com/docs/api/users/list

Example request using HttpClient in .NET.

```csharp
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");

var response = await client.GetAsync("https://app.rybbit.io/api/sites/1/users?page=1&page_size=10&sort_by=last_seen&sort_order=desc");
var data = await response.Content.ReadAsStringAsync();
```

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

### rybbit.startSessionReplay()

Source: https://rybbit.com/docs/sdks/web

Manually starts the session recording process. This method only functions if session replay is enabled in the Rybbit dashboard.

```APIDOC
### rybbit.startSessionReplay()

Starts the session recording. Requires session replay to be enabled in the Rybbit dashboard.
```

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

### Get Users Java Request

Source: https://rybbit.com/docs/api/users/list

Example request using HttpClient in Java.

```java
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://app.rybbit.io/api/sites/1/users?page=1&page_size=10&sort_by=last_seen&sort_order=desc"))
    .header("Authorization", "Bearer your_api_key_here")
    .GET()
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
```

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

### Make Setup Scripts Executable

Source: https://rybbit.com/docs/self-hosting

Ensure all shell scripts in the repository are executable before running the setup process.

```bash
chmod +x *.sh
```

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

### Clear User ID Example

Source: https://rybbit.com/docs/sdks/web

Example of clearing the user ID during logout.

```javascript
// When a user logs out
rybbit.clearUserId();
```

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

### Manual Session Replay Controls

Source: https://rybbit.com/docs/sdks/web

Use these methods to manually start, stop, or check the status of session recording. Recording only starts if enabled in the Rybbit dashboard.

```javascript
// Start recording (only works if enabled in dashboard)
rybbit.startSessionReplay();

// Stop recording
rybbit.stopSessionReplay();

// Check if currently recording
const isRecording = rybbit.isSessionReplayActive();
if (isRecording) {
  console.log("Session is being recorded");
}
```

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

### Get Users by Trait Response Example

Source: https://rybbit.com/docs/api/user-traits/users

The JSON structure returned by the API.

```json
{
  "users": [
    {
      "user_id": "a1b2c3",
      "identified_user_id": "user_987",
      "traits": { "plan": "pro", "company": "Acme" },
      "country": "US",
      "region": "California",
      "city": "CA-San Francisco",
      "browser": "Chrome",
      "operating_system": "macOS",
      "device_type": "desktop",
      "sessions": 14
    }
  ],
  "total": 1,
  "hasMore": false
}
```

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

### Get Overview Go Request

Source: https://rybbit.com/docs/api/overview/overview

Example request using Go's net/http package to retrieve site overview data.

```go
req, _ := http.NewRequest("GET", "https://app.rybbit.io/api/sites/123/overview?start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")

client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

var data map[string]interface{}
json.NewDecoder(resp.Body).Decode(&data)
```

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

### Declarative event tracking with data attributes

Source: https://rybbit.com/docs/sdks/web

Examples of using data-rybbit-event and data-rybbit-prop-* attributes to track interactions directly in HTML.

```html
<button data-rybbit-event="cta_click">Click Me</button>

<button
  data-rybbit-event="add_to_cart"
  data-rybbit-prop-item_id="product-123"
  data-rybbit-prop-item_name="Classic T-Shirt"
  data-rybbit-prop-price="29.99"
>
  Add to Cart
</button>
```

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

### Create Import Go Request

Source: https://rybbit.com/docs/api/imports/create

Example request using the Go standard library.

```go
body := map[string]interface{}{
    "platform": "plausible",
}
jsonBody, _ := json.Marshal(body)

req, _ := http.NewRequest("POST", "https://app.rybbit.io/api/sites/123/imports", bytes.NewBuffer(jsonBody))
req.Header.Set("Authorization", "Bearer your_api_key_here")
req.Header.Set("Content-Type", "application/json")

client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

var data map[string]interface{}
json.NewDecoder(resp.Body).Decode(&data)
```

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

### Get Organizations .NET Request

Source: https://rybbit.com/docs/api/organizations/list

Example request using HttpClient in .NET.

```csharp
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");

var response = await client.GetAsync("https://app.rybbit.io/api/organizations");
var data = await response.Content.ReadAsStringAsync();
```

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

### Get Organizations Java Request

Source: https://rybbit.com/docs/api/organizations/list

Example request using Java HttpClient.

```java
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://app.rybbit.io/api/organizations"))
    .header("Authorization", "Bearer your_api_key_here")
    .GET()
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
```

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

### Get Organization Sites Go Request

Source: https://rybbit.com/docs/api/organizations/sites

Example request using the net/http package in Go.

```go
organizationId := "org_abc123"
req, _ := http.NewRequest("GET", "https://app.rybbit.io/api/organizations/"+organizationId+"/sites", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")

client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

var data map[string]interface{}
json.NewDecoder(resp.Body).Decode(&data)
```

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

### Get Organizations Rust Request

Source: https://rybbit.com/docs/api/organizations/list

Example request using the reqwest crate.

```rust
let client = reqwest::Client::new();
let res = client
    .get("https://app.rybbit.io/api/organizations")
    .header("Authorization", "Bearer your_api_key_here")
    .send()
    .await?;

let data: serde_json::Value = res.json().await?;
```

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

### Start Server with Node

Source: https://rybbit.com/docs/proxy-guide/express

Command to start the Express server using Node.js.

```bash
node server.js
```

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

### Manually Track Outbound Click

Source: https://rybbit.com/docs/sdks/web

Example of manually tracking an outbound click triggered by a button element.

```javascript
// Manually track an outbound click triggered by a button
document.getElementById("external-service-button")?.addEventListener("click", () => {
  let url = "https://external-service.com";
  rybbit.trackOutbound(url, "Visit External Service", "_blank");
  // Optionally navigate after tracking
  window.open(url, "_blank");
});
```

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

### Manually Capture Errors

Source: https://rybbit.com/docs/sdks/web

Examples of manually capturing errors within try-catch blocks and async operations.

```javascript
try {
  // Some risky operation
  processPayment(orderData);
} catch (error) {
  rybbit.error(error, {
    component: "checkout",
    orderId: "order-123",
    userId: currentUser.id
  });
  // Handle error in your UI
  showErrorMessage("Payment failed");
}

// Capture error from async operation
async function fetchUserData(userId) {
  try {
    const response = await fetch(`/api/users/${userId}`);
    return await response.json();
  } catch (error) {
    rybbit.error(error, {
      endpoint: "/api/users",
      userId: userId
    });
    throw error;
  }
}
```

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

### Cleanup in React useEffect

Source: https://rybbit.com/docs/sdks/web

Example of using rybbit.cleanup() within a React useEffect hook to ensure proper cleanup on component unmount.

```javascript
// In React
useEffect(() => {
  rybbit.init({
    analyticsHost: "https://app.rybbit.io/api",
    siteId: "1",
  });

  return () => {
    rybbit.cleanup();
  };
}, []);
```

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

### List API Keys Go Request

Source: https://rybbit.com/docs/api/api-keys/list

Example request using the net/http package in Go.

```go
req, _ := http.NewRequest("GET", "https://app.rybbit.io/api/auth/api-key/list?limit=20", nil)
req.Header.Set("Cookie", "better-auth.session_token=YOUR_SESSION_TOKEN")

client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

var data map[string]interface{}
json.NewDecoder(resp.Body).Decode(&data)
```

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

### Get Site .NET Request

Source: https://rybbit.com/docs/api/sites/get

Example request using .NET HttpClient.

```csharp
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");

var response = await client.GetAsync("https://app.rybbit.io/api/sites/123");
var data = await response.Content.ReadAsStringAsync();
```

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

### Build and run Node.js server

Source: https://rybbit.com/docs/proxy-guide/astro

Commands to build the project and start the server for self-hosting.

```bash
npm run build
node ./dist/server/entry.mjs
```

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

### Get User ID Syntax

Source: https://rybbit.com/docs/sdks/web

The getUserId method retrieves the currently stored user ID.

```javascript
rybbit.getUserId(): string | null;
```

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

### Get Site Java Request

Source: https://rybbit.com/docs/api/sites/get

Example request using Java HttpClient.

```java
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://app.rybbit.io/api/sites/123"))
    .header("Authorization", "Bearer your_api_key_here")
    .GET()
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
```

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

### Get Site Rust Request

Source: https://rybbit.com/docs/api/sites/get

Example request using the reqwest crate.

```rust
let client = reqwest::Client::new();
let res = client
    .get("https://app.rybbit.io/api/sites/123")
    .header("Authorization", "Bearer your_api_key_here")
    .send()
    .await?;

let data: serde_json::Value = res.json().await?;
```

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

### Go Request for Bot Overview

Source: https://rybbit.com/docs/api/bots/overview

Example request using the standard net/http library in Go.

```go
req, _ := http.NewRequest("GET", "https://app.rybbit.io/api/sites/123/bots/overview?start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")

client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

var data map[string]interface{}
json.NewDecoder(resp.Body).Decode(&data)
```

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

### List Imports Go Request

Source: https://rybbit.com/docs/api/imports/list

Example request using the standard net/http library in Go.

```go
package main

import (
    "encoding/json"
    "io"
    "net/http"
)

func main() {
    url := "https://app.rybbit.io/api/sites/123/imports"

    req, _ := http.NewRequest("GET", url, nil)
    req.Header.Add("Authorization", "Bearer your_api_key_here")

    client := &http.Client{}
    resp, _ := client.Do(req)
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)

    var data map[string]interface{}
    json.Unmarshal(body, &data)
}
```

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

### Get Organizations Ruby Request

Source: https://rybbit.com/docs/api/organizations/list

Example request using Net::HTTP.

```ruby
require 'net/http'
require 'json'

uri = URI('https://app.rybbit.io/api/organizations')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

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

### Install Vercel adapter

Source: https://rybbit.com/docs/proxy-guide/astro

Install the Vercel adapter package for deployment.

```bash
npm install @astrojs/vercel
```

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

### Get Teams .NET Request

Source: https://rybbit.com/docs/api/teams/list

Example request using HttpClient in .NET.

```csharp
var organizationId = "org_abc123";
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");

var response = await client.GetAsync($"https://app.rybbit.io/api/organizations/{organizationId}/teams");
var data = await response.Content.ReadAsStringAsync();
```

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

### Get Teams Java Request

Source: https://rybbit.com/docs/api/teams/list

Example request using HttpClient in Java.

```java
String organizationId = "org_abc123";
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://app.rybbit.io/api/organizations/" + organizationId + "/teams"))
    .header("Authorization", "Bearer your_api_key_here")
    .GET()
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
```

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

### Create API Key with Go

Source: https://rybbit.com/docs/api/api-keys/create

Example request using the net/http package in Go to create an API key.

```go
body := bytes.NewBuffer([]byte(`{
  "name": "CI pipeline",
  "expiresIn": 2592000
}`))
req, _ := http.NewRequest("POST", "https://app.rybbit.io/api/user/api-keys", body)
req.Header.Set("Cookie", "better-auth.session_token=YOUR_SESSION_TOKEN")
req.Header.Set("Content-Type", "application/json")

client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

var data map[string]interface{}
json.NewDecoder(resp.Body).Decode(&data)
```

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

### Get Teams PHP Request

Source: https://rybbit.com/docs/api/teams/list

Example request using cURL in PHP.

```php
$organizationId = 'org_abc123';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://app.rybbit.io/api/organizations/{$organizationId}/teams");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer your_api_key_here'
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
```

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

### Get Goal Sessions Go Request

Source: https://rybbit.com/docs/api/goals/sessions

Example request using the standard net/http library in Go.

```go
package main

import (
    "encoding/json"
    "io"
    "net/http"
)

func main() {
    url := "https://app.rybbit.io/api/sites/1/goals/1/sessions?page=1&limit=10"

    req, _ := http.NewRequest("GET", url, nil)
    req.Header.Add("Authorization", "Bearer your_api_key_here")

    client := &http.Client{}
    resp, _ := client.Do(req)
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)

    var data map[string]interface{}
    json.Unmarshal(body, &data)
}
```

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

### Get Site PHP Request

Source: https://rybbit.com/docs/api/sites/get

Example request using PHP cURL.

```php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://app.rybbit.io/api/sites/123');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer your_api_key_here'
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
```

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

### Install Rybbit SDK

Source: https://rybbit.com/docs/sdks/node

Install the Rybbit Node.js package using npm or yarn.

```bash
npm install @rybbit/node
```

```bash
yarn add @rybbit/node
```

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

### Create Site Ruby Request

Source: https://rybbit.com/docs/api/organizations/create-site

Example request using Net::HTTP in Ruby.

```ruby
require 'net/http'
require 'json'

organization_id = 'org_123'
uri = URI("https://app.rybbit.io/api/organizations/#{organization_id}/sites")
req = Net::HTTP::Post.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
req['Content-Type'] = 'application/json'
req.body = {
  domain: 'example.com',
  name: 'My Website',
  blockBots: true
}.to_json

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

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

### Get Sessions Response

Source: https://rybbit.com/docs/api/sessions/list

Example JSON response structure for the sessions list.

```json
{
  "data": [
    {
      "session_id": "sess_abc123",
      "user_id": "dev_xyz789",
      "identified_user_id": "user@example.com",
      "traits": { "plan": "pro" },
      "country": "US",
      "region": "California",
      "city": "San Francisco",
      "browser": "Chrome",
      "operating_system": "macOS",
      "device_type": "desktop",
      "referrer": "https://google.com",
      "channel": "organic",
      "entry_page": "/",
      "exit_page": "/pricing",
      "pageviews": 5,
      "events": 2,
      "session_duration": 245,
      "session_start": "2024-01-31T14:00:00.000Z",
      "session_end": "2024-01-31T14:04:05.000Z",
      "utm_source": "google",
      "utm_medium": "cpc",
      "utm_campaign": "brand"
    }
  ]
}
```

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

### Get Site Has Data Go Request

Source: https://rybbit.com/docs/api/sites/has-data

Example request using Go's net/http package.

```go
req, _ := http.NewRequest("GET", "https://app.rybbit.io/api/sites/123/has-data", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")

client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

var data map[string]interface{}
json.NewDecoder(resp.Body).Decode(&data)
```

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

### Get Site Python Request

Source: https://rybbit.com/docs/api/sites/get

Example request using the requests library.

```python
import requests

response = requests.get(
    'https://app.rybbit.io/api/sites/123',
    headers={
        'Authorization': 'Bearer your_api_key_here'
    }
)

data = response.json()
```

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

### Get Sessions .NET Request

Source: https://rybbit.com/docs/api/sessions/list

Example request using HttpClient in .NET.

```csharp
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");

var response = await client.GetAsync("https://app.rybbit.io/api/sites/1/sessions?page=1&limit=20&start_date=2024-01-01&end_date=2024-01-31");
var data = await response.Content.ReadAsStringAsync();
```

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

### Initialize Rybbit SDK

Source: https://rybbit.com/docs/sdks/node

Syntax for initializing the Rybbit client.

```javascript
import { Rybbit } from "@rybbit/node";

const rybbit = new Rybbit(config: RybbitConfig);
```

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

### Get Session Replays Go Request

Source: https://rybbit.com/docs/api/session-replay/list

Example request using the net/http package in Go.

```go
req, _ := http.NewRequest("GET", "https://app.rybbit.io/api/sites/123/session-replay/list?limit=50&offset=0&start_date=2024-01-01&end_date=2024-01-31", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")

client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

var data map[string]interface{}
json.NewDecoder(resp.Body).Decode(&data)
```

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

### Get Site JavaScript Request

Source: https://rybbit.com/docs/api/sites/get

Example request using the Fetch API.

```javascript
const response = await fetch(
  'https://app.rybbit.io/api/sites/123',
  {
    headers: {
      'Authorization': 'Bearer your_api_key_here'
    }
  }
);

const data = await response.json();
```

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

### Get Sessions Java Request

Source: https://rybbit.com/docs/api/sessions/list

Example request using the Java HttpClient.

```java
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://app.rybbit.io/api/sites/1/sessions?page=1&limit=20&start_date=2024-01-01&end_date=2024-01-31"))
    .header("Authorization", "Bearer your_api_key_here")
    .GET()
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
```

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

### Get Overview Java Request

Source: https://rybbit.com/docs/api/overview/overview

Example request using Java's HttpClient to retrieve site overview data.

```java
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://app.rybbit.io/api/sites/123/overview?start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York"))
    .header("Authorization", "Bearer your_api_key_here")
    .GET()
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
```
Tokens:
Raw