SnapTrack API
API Documentation
Complete guide to integrating with SnapTrack API
Welcome! This documentation will help you get started with the SnapTrack API. All endpoints require authentication and are subject to rate limiting based on your subscription plan.
What is the SnapTrack API?
The SnapTrack API provides programmatic access to your website monitoring, screenshot management, scenario testing, and scheduling capabilities. You can automate your workflow, integrate with third-party services, and build custom applications.
Key Features
- Website Management: Create, read, update, and delete websites
- Screenshot Management: Capture, retrieve, and manage screenshots
- Scenario Testing: Run automated testing scenarios
- Schedule Management: Create and manage screenshot schedules
- Rate Limiting: Plan-based rate limits to ensure fair usage
- Webhooks: Receive real-time updates (coming soon)
Quick Start
- Get API Token: Generate a token from your Settings page
- Choose Authentication: Use Bearer token in Authorization header
- Make Requests: Start calling endpoints with your token
- Handle Errors: Check response codes and error messages
Base URL
https://api.example.com/
http://localhost:8000/api/API Versions
Currently, we maintain one stable API version (v1). All endpoints are accessible at /api.
Authentication Methods
We support multiple authentication methods:
- Sanctum Bearer Token: From /api/auth/login or /api/auth/register
- API Token: From Settings → API Keys (SHA-256 hashed)
Subscription Plans & API Access
API access is based on your subscription plan:
| Plan | API Access | Rate Limit | Websites | Scenarios |
|---|---|---|---|---|
| Free | ❌ No | - | 1 | 0 |
| Starter | ✅ Yes | 5/min | 5 | 0 |
| Pro | ✅ Yes | 20/min | 25 | 3 |
| Business | ✅ Yes | 60/min | 100 | Unlimited |
Getting Help
Need help? Check out our FAQ or
contact support.