Quick Start
Get TraceScout up and running in your application in just a few minutes.
Prerequisites
Before you begin, you'll need:
- A TraceScout account (sign up at app.tracescout.com)
- Your API key, organization ID, and project ID from the dashboard
- A web application to integrate with
Step 1: Add the SDK
The quickest way to add TraceScout is via CDN:
<script src="https://cdn.tracescout.com/sdk/tracescout.min.js"></script>
Or install via npm:
npm install @tracescout/suite
Step 2: Initialize TraceScout
Add this code to your application, ideally as early as possible:
TraceScout.init({
apiKey: 'ts_api_your_api_key',
organizationId: 'your-organization-uuid',
projectId: 'your-project-uuid',
environment: 'production'
});
Finding Your Credentials
You can find your API key, organization ID, and project ID in the TraceScout dashboard under Project Settings → SDK Configuration.
Step 3: Verify Installation
Once initialized, TraceScout will automatically:
- Start recording user sessions
- Capture network requests
- Log console messages
- Track JavaScript errors
Open your browser's developer console. You should see:
[TraceScout] ✅ SDK Initialized Successfully
[TraceScout] Features enabled: sessionRecording, networkMonitoring, consoleCapture, errorTracking
Step 4: View Sessions
- Go to app.tracescout.com
- Select your organization and project
- Navigate to Sessions
- You should see your first recording!
Congratulations!
You've successfully integrated TraceScout. Sessions will now be recorded and available in your dashboard.