API Documentation

{
  "events": [
    {
      "message": "Your log message here",
      "level": "info",
      "ts": "2024-01-15T14:30:00.000Z",
      "metadata": { "key": "value" },
      "streamName": "api-logs"
    }
  ]
}

{
  "success": true,
  "data": {
    "acceptedCount": 3,
    "rejectedCount": 0
  }
}

{
  "success": true,
  "data": {
    "acceptedCount": 2,
    "rejectedCount": 1,
    "errors": [
      {
        "index": 1,
        "reason": "Invalid log level: critical. Must be one of: trace, debug, info, warn, error, fatal"
      }
    ]
  }
}

curl -X POST https://your-domain/api/ingest \
  -H "Authorization: Bearer lrk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "events": [{
      "message": "User logged in",
      "level": "info",
      "metadata": { "userId": "123" }
    }]
  }'

curl -X POST https://your-domain/api/ingest \
  -H "Authorization: Bearer lrk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "events": [
      { "message": "Request started", "level": "debug" },
      { "message": "Processing data", "level": "info", "metadata": { "items": 42 } },
      { "message": "Request completed", "level": "info" }
    ]
  }'

async function sendLog(apiKey, message, level, metadata = {}) {
  const response = await fetch('/api/ingest', {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${apiKey}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      events: [{
        message,
        level,
        metadata,
        ts: new Date().toISOString(), // Optional: defaults to server time
      }],
    }),
  });

  if (!response.ok) {
    const error = await response.json();
    throw new Error(error.error?.message || 'Failed to send log');
  }

  return response.json();
}

// Usage
await sendLog('lrk_your_api_key', 'User signed up', 'info', {
  userId: 'user_123',
  plan: 'premium',
});

import requests
from datetime import datetime, timezone

def send_logs(api_key: str, events: list[dict]) -> dict:
    """Send log events to LogRack."""
    response = requests.post(
        "https://your-domain/api/ingest",
        headers={
            "Authorization": f"Bearer {api_key}",
            "Content-Type": "application/json",
        },
        json={"events": events},
    )
    response.raise_for_status()
    return response.json()

# Single log
send_logs("lrk_your_api_key", [{
    "message": "Payment processed",
    "level": "info",
    "metadata": {"amount": 99.99, "currency": "USD"},
}])

# Batch of logs
send_logs("lrk_your_api_key", [
    {"message": "Order created", "level": "info"},
    {"message": "Inventory checked", "level": "debug"},
    {"message": "Payment processed", "level": "info"},
    {"message": "Order confirmed", "level": "info"},
])

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "cm5abc123def456",
        "timestamp": "2024-01-15T14:30:00.000Z",
        "ingestedAt": "2024-01-15T14:30:01.234Z",
        "level": "error",
        "message": "Connection timeout after 30s",
        "metadata": {
          "service": "api-gateway",
          "requestId": "req_789xyz"
        }
      },
      {
        "id": "cm5abc123def457",
        "timestamp": "2024-01-15T14:29:55.000Z",
        "ingestedAt": "2024-01-15T14:29:56.123Z",
        "level": "warn",
        "message": "High latency detected",
        "metadata": {
          "latencyMs": 2500
        }
      }
    ],
    "nextCursor": "eyJ0cyI6IjIwMjQtMDEtMTVUMTQ6Mjk6NTUuMDAwWiIsImlkIjoiY201YWJjMTIzZGVmNDU3In0",
    "pageInfo": {
      "limit": 50,
      "returned": 2
    }
  }
}

curl -X GET "https://your-domain/api/logs?limit=50&order=desc" \
  -H "Authorization: Bearer lrk_your_api_key"

curl -X GET "https://your-domain/api/logs?level=error&level=warn&q=timeout&limit=100" \
  -H "Authorization: Bearer lrk_your_api_key"

curl -X GET "https://your-domain/api/logs?start=2024-01-15T00:00:00Z&end=2024-01-16T00:00:00Z" \
  -H "Authorization: Bearer lrk_your_api_key"

curl -X GET "https://your-domain/api/logs?cursor=eyJ0cyI6IjIwMjQtMDEtMTVUMTQ6MzA6MDAuMDAwWiIsImlkIjoiYWJjMTIzIn0" \
  -H "Authorization: Bearer lrk_your_api_key"

{
  "id": "cm5abc123def456",
  "timestamp": "2024-01-15T14:30:00.000Z",
  "ingestedAt": "2024-01-15T14:30:01.234Z",
  "level": "error",
  "message": "Connection timeout after 30s",
  "metadata": {
    "service": "api-gateway",
    "requestId": "req_789xyz"
  }
}

{
  "error": "NOT_FOUND",
  "message": "Log entry not found"
}

curl -X GET "https://your-domain/api/logs/cm5abc123def456" \
  -H "Authorization: Bearer lrk_your_api_key"

{
  "success": true,
  "data": {
    "total": 15234,
    "byLevel": {
      "debug": 2100,
      "info": 10500,
      "warn": 1800,
      "error": 780,
      "fatal": 54
    },
    "timeRange": {
      "start": "2024-01-15T00:00:00.000Z",
      "end": "2024-01-16T00:00:00.000Z"
    }
  }
}

curl -X GET "https://your-domain/api/logs/stats?start=2024-01-15T00:00:00Z&end=2024-01-16T00:00:00Z" \
  -H "Authorization: Bearer lrk_your_api_key"

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "cm5abc123def458",
        "timestamp": "2024-01-15T14:31:15.000Z",
        "ingestedAt": "2024-01-15T14:31:16.123Z",
        "level": "error",
        "message": "Database connection failed",
        "metadata": {
          "database": "postgres",
          "retryCount": 3
        }
      }
    ],
    "nextSince": "2024-01-15T14:31:16.123Z",
    "count": 1
  }
}

async function tailLogs(apiKey, onLogs) {
  let since = new Date(Date.now() - 10000).toISOString(); // Start 10s ago

  while (true) {
    const response = await fetch(`/api/tail?since=${since}`, {
      headers: { 'Authorization': `Bearer ${apiKey}` },
    });
    
    const { data } = await response.json();
    
    if (data.items.length > 0) {
      onLogs(data.items);
    }
    
    since = data.nextSince; // Use nextSince for next poll
    await new Promise(r => setTimeout(r, 1500)); // Poll every 1.5s
  }
}

curl -X GET "https://your-domain/api/tail?since=2024-01-15T14:30:00Z" \
  -H "Authorization: Bearer lrk_your_api_key"

curl -X GET "https://your-domain/api/tail?since=2024-01-15T14:30:00Z&level=error&streamId=cm5stream123" \
  -H "Authorization: Bearer lrk_your_api_key"

curl -X GET "https://your-domain/api/streams" \
  -H "Authorization: Bearer lrk_your_api_key"

{
  "success": true,
  "data": {
    "streams": [
      {
        "id": "cm5stream123abc",
        "name": "api-logs",
        "description": "API server access logs",
        "createdAt": "2024-01-10T09:00:00.000Z",
        "updatedAt": "2024-01-10T09:00:00.000Z"
      },
      {
        "id": "cm5stream456def",
        "name": "worker-jobs",
        "description": "Background job processing logs",
        "createdAt": "2024-01-12T11:30:00.000Z",
        "updatedAt": "2024-01-14T15:45:00.000Z"
      }
    ],
    "total": 2
  }
}

curl -X POST "https://your-domain/api/streams" \
  -H "Authorization: Bearer lrk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "payment-service",
    "description": "Payment processing logs"
  }'

{
  "success": true,
  "data": {
    "id": "cm5stream789ghi",
    "name": "payment-service",
    "description": "Payment processing logs",
    "createdAt": "2024-01-15T14:30:00.000Z",
    "updatedAt": "2024-01-15T14:30:00.000Z"
  }
}

curl -X GET "https://your-domain/api/streams/cm5stream123abc" \
  -H "Authorization: Bearer lrk_your_api_key"

curl -X PATCH "https://your-domain/api/streams/cm5stream123abc" \
  -H "Authorization: Bearer lrk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "api-access-logs",
    "description": "Updated: API server access and error logs"
  }'

{
  "success": true,
  "data": {
    "id": "cm5stream123abc",
    "name": "api-access-logs",
    "description": "Updated: API server access and error logs",
    "createdAt": "2024-01-10T09:00:00.000Z",
    "updatedAt": "2024-01-15T14:35:00.000Z"
  }
}

curl -X DELETE "https://your-domain/api/streams/cm5stream123abc" \
  -H "Authorization: Bearer lrk_your_api_key"

Authorization: Bearer lrk_your_api_key

{
  "success": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "The provided API key is invalid or does not exist"
  }
}