← Back to Table of Contents

User Guide

Complete user guide for the Open Source Site Tracking platform, covering all features and functionality.

Getting Started Dashboard Projects Analytics Reports Settings Troubleshooting

Getting Started

Account Setup

1Create Account

  1. Navigate to the application homepage
  2. Click "Sign Up" in the top navigation
  3. Enter your email address and create a password
  4. Click "Create Account"
  5. Check your email for verification (if enabled)
  6. Log in with your new credentials

2Complete Profile

  1. Click on your profile picture in the top right
  2. Select "Profile Settings"
  3. Fill in your profile information:
    • First name and last name
    • Display name
    • Timezone
    • Language preference
  4. Click "Save Changes"

First Project

3Create Your First Project

  1. From the dashboard, click "Add New Project"
  2. Fill in project details:
    • Name: My First Project
    • Repository URL: https://github.com/username/repo
    • Description: My awesome project
    • Tracking Domain: mydomain.com (optional)
  3. Click "Create Project"
  4. Copy your Project ID for tracking setup

4Add Tracking Code

  1. Copy your Project ID from the project page
  2. Add this script to your website's <head> section: 
    <script src="https://your-domain.com/tracking.js" 
        data-project-id="your-project-id"></script>
  3. Replace your-project-id with your actual Project ID
  4. Visit your website to start tracking

Dashboard

Dashboard Overview

The dashboard provides a comprehensive overview of your analytics data and project status.

Key Components

Dashboard Features

Real-time Analytics

Project Management

Projects

Project Management

Creating Projects

  1. Click "Add New Project" from the dashboard
  2. Fill in project information:
    • Name: Project name (required)
    • Description: Project description (optional)
    • Repository URL: GitHub/Bitbucket URL (optional)
    • Tracking Domain: Domain for tracking (optional)
    • Category: Project category (optional)
  3. Click "Create Project"

Editing Projects

  1. Go to the project page
  2. Click "Edit Project"
  3. Update project information
  4. Click "Save Changes"

Deleting Projects

  1. Go to the project page
  2. Click "Delete Project"
  3. Confirm deletion (this cannot be undone)

Project Settings

Tracking Configuration

Integration Settings

Analytics

Analytics Overview

The analytics section provides comprehensive insights into your website traffic and user behavior.

Key Metrics

Metric Description Use Case
Page Views Total number of page views Measure overall traffic
Unique Visitors Number of unique visitors Measure audience size
Average Session Duration Average time spent on site Measure engagement
Bounce Rate Percentage of single-page visits Measure content effectiveness
Conversion Rate Percentage of goal completions Measure conversion effectiveness

Page Analytics

Page Performance

Page Insights

Visitor Analytics

Visitor Insights

Behavioral Analytics

Real-time Analytics

Live Monitoring

Live Dashboard

Reports

Report Generation

Creating Reports

  1. Navigate to the Reports section
  2. Click "Create New Report"
  3. Configure report settings:
    • Report Type: Choose report type
    • Date Range: Select time period
    • Metrics: Choose metrics to include
    • Filters: Apply data filters
    • Format: Choose output format
  4. Click "Generate Report"

Report Types

Export Options

Export Formats

Scheduled Reports

Settings

User Settings

Profile Management

Preferences

Notification Settings

Email Notifications

Push Notifications

Security Settings

Account Security

Privacy Settings

Troubleshooting

Common Issues

Tracking Not Working

Solutions:
  • Check that tracking script is correctly installed
  • Verify Project ID is correct
  • Check browser console for errors
  • Ensure website is accessible
  • Check if ad blockers are blocking the script

Data Not Appearing

Solutions:
  • Wait a few minutes for data to process
  • Check project status
  • Verify tracking is working
  • Check data retention settings
  • Contact support if issue persists

Login Issues

Solutions:
  • Reset password using "Forgot Password"
  • Check email for verification link
  • Clear browser cache and cookies
  • Try different browser
  • Contact support if issue persists

Getting Help

Tips for Success

  • Regular Monitoring: Check analytics regularly
  • Set Goals: Define conversion goals
  • Test Tracking: Verify tracking is working
  • Review Reports: Regularly review performance
  • Optimize: Use insights to improve performance