Skip to content

Quick Start

Get up and running with ByteFreezer in minutes.

Prerequisites

  • Access to the ByteFreezer dashboard
  • A tenant and dataset configured (or permissions to create them)

Step 1: Create a Tenant

  1. Navigate to Tenants in the dashboard
  2. Click Create Tenant
  3. Enter a unique ID (e.g., my-app-prod)
  4. Add a descriptive name
  5. Click Create

Step 2: Create a Dataset

  1. Navigate to Datasets in the dashboard
  2. Select your tenant
  3. Click Create Dataset
  4. Enter a unique ID (e.g., access-logs)
  5. Configure retention and other settings
  6. Click Create

Step 3: Send Data

Once your dataset is active, you can send data via the webhook endpoint:

curl -X POST \
  https://receiver.bytefreezer.com/webhook/{tenant_id}/{dataset_id} \
  -H "Content-Type: application/json" \
  -d '{"timestamp": "2024-01-15T10:30:00Z", "level": "info", "message": "Hello ByteFreezer!"}'

Sending Multiple Events

Use JSON Lines format to send multiple events in one request:

curl -X POST \
  https://receiver.bytefreezer.com/webhook/{tenant_id}/{dataset_id} \
  -H "Content-Type: application/json" \
  -d '{"timestamp": "2024-01-15T10:30:00Z", "level": "info", "message": "Event 1"}
{"timestamp": "2024-01-15T10:30:01Z", "level": "warn", "message": "Event 2"}
{"timestamp": "2024-01-15T10:30:02Z", "level": "error", "message": "Event 3"}'

Step 4: Configure Transformations (Optional)

To process your data in-flight:

  1. Navigate to Transformations
  2. Select your dataset
  3. Build a filter pipeline using the visual editor or AI assistant
  4. Test with sample data
  5. Activate the transformation

Next Steps