Documentation

Integrate LogScout in minutes

Simple, developer-friendly APIs and SDKs. Start logging in less than 5 minutes.

// Quick start

Get started in 3 simple steps

1. Create your account

Sign up for a free LogScout account. No credit card required.

2. Get your API key

Navigate to Settings > API Keys and generate a new key.

3. Send your first log

Use our simple HTTP API or SDK to send your first log entry.

// SDKs & Examples

Choose your integration method

Node.js

npm install @logscout/node

                
                  import { LogScout } from '@logscout/node';

const logger = new LogScout({
  apiKey: 'your_api_key_here',
});

logger.info('Application started', {
  version: '1.0.0',
});
                
              

Python

pip install logscout

                
                  from logscout import LogScout

logger = LogScout(
    api_key='your_api_key_here',
)

logger.info('Application started', {
    'version': '1.0.0',
})
                
              

HTTP API

No installation required

                
                  curl -X POST https://api.logscout.dev/v1/logs \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "source": "my-app",
    "level": "INFO",
    "message": "Application started",
    "metadata": {
      "version": "1.0.0",
    }
  }'
                
              

// API Reference

Core API endpoints

POST /v1/logs

Send a log entry to LogScout.

Request Body

                {
  "source": "string",      // Required: Source identifier
  "level": "string",       // Required: info|warn|error|debug
  "message": "string",     // Required: Log message
  "timestamp": "string",   // Optional: ISO 8601 timestamp
  "metadata": {}           // Optional: Additional context
}
              

Response (200 OK)

                {
  "id": "log_abc123",
  "status": "success",
  "timestamp": "2025-11-23T12:00:00Z"
}
              

Fast Integration

Get up and running in under 5 minutes with our simple SDKs.

Secure Authentication

API keys with granular permissions and automatic rotation.

Comprehensive Docs

Detailed guides, examples, and API references.

// Advanced

Advanced integration topics

Structured Logging

Use structured metadata to make logs searchable and filterable.

            logger.info('User login', {
  userId: 'usr_123',
  ipAddress: '192.168.1.1',
  userAgent: 'Mozilla/5.0...'
});
          

Error Tracking

Automatically capture stack traces and error context.

            try {
  riskyOperation();
} catch (error) {
  logger.error('Operation failed', {
    error: error.message,
    stack: error.stack
  });
}
          

Batch Logging

Send multiple logs in a single request for better performance.

            logger.batch([
  { level: 'info', message: 'Log 1' },
  { level: 'warn', message: 'Log 2' },
  { level: 'error', message: 'Log 3' }
]);
          

Retention Policies

Configure per-source retention to optimize storage costs.

            # Set via Dashboard
Settings > Sources > my-app
Retention: 7 days
Archive: enabled
          

Ready to get started?

Start logging in minutes

Create your free account and send your first log today. No credit card required.