Frequently Asked Questions
Common questions and answers about the SnapTrack API
General Questions
Q: What is the SnapTrack API?
A: The SnapTrack API allows you to programmatically manage websites, screenshots, scenarios, and schedules. It's perfect for integrations, automation, and custom applications.
Q: Do I need API access?
A: Only if you want to use our API. Free plan users can use the web dashboard without the API. Starter plan and higher include API access.
Q: Is the API free?
A: API access is included in paid plans (Starter, Pro, Business). Free plan users don't have API access, but can use the web interface.
Q: What can I do with the API?
A: You can:
- Create and manage websites
- Take and download screenshots
- Create and run test scenarios
- Create and manage schedules
- Build custom integrations
Authentication
Q: How do I get an API token?
A: Go to your Dashboard → Settings → API Keys → "Generate API Token". Copy and save the token securely.
Q: Can I have multiple API tokens?
A: Currently, you can have one active API token per account. You can regenerate it anytime, which invalidates the old one.
Q: What if my API token is compromised?
A: Go to Settings → API Keys → "Revoke Token" to immediately invalidate it. Then generate a new one.
Q: How long do API tokens expire?
A: API tokens don't expire unless you revoke them. They remain valid until you manually revoke or regenerate.
Q: Can I use my login password as an API token?
A: No. Always use the dedicated API token from Settings. Never use your password for API requests.
Rate Limiting
Q: What are rate limits?
A: Rate limits prevent abuse and ensure fair usage. They limit how many requests you can make per minute.
Q: What's my rate limit?
A: It depends on your plan:
- Free: No API access
- Starter: 5 requests/minute
- Pro: 20 requests/minute
- Business: 60 requests/minute
Q: What happens when I hit my rate limit?
A: You'll get a 429 response. Wait for the reset time (shown in the error) to make more requests.
Q: How can I increase my rate limit?
A: Upgrade to a higher plan. Each plan has a higher rate limit.
Q: Do rate limits reset daily or hourly?
A: Rate limits reset every minute, not daily or hourly.
Q: Can I make requests in bulk to avoid rate limits?
A: No, bulk requests still count toward your rate limit. The best approach is to batch operations or upgrade your plan.
API Usage
Q: Can I delete websites via the API?
A: Yes. Use DELETE /websites/{id}
Q: How do I download screenshots?
A: Use GET /screenshots/{id}/download for single or POST /screenshots/download-bulk for multiple (Pro/Business only).
Q: Can I run scenarios via the API?
A: Yes. Use POST /scenarios/{id}/run
Q: Are webhooks available via API?
A: Webhooks are coming soon. Currently, you can only use the web dashboard to configure them.
Q: Can I create schedules via the API?
A: Yes. Use POST /schedules to create and manage schedules.
Data & Storage
Q: How long is screenshot history kept?
A: It depends on your plan:
- Free: 7 days
- Starter: 30 days
- Pro: 90 days
- Business: 365 days
Q: Can I export all my screenshots?
A: Yes. You can download individual screenshots or bulk download multiple as ZIP (Pro/Business only).
Q: What happens to my data when I downgrade?
A: Your data remains. You can still access it, but some features may be disabled based on your new plan limits.
Errors & Troubleshooting
Q: I'm getting 401 Unauthorized. What's wrong?
A: Your token is invalid or missing. Check:
- Token is correct (copy from Settings)
- Header format: Authorization: Bearer YOUR_TOKEN
- No extra spaces or characters
Q: I'm getting 403 Forbidden. What does it mean?
A: Your plan doesn't have API access. Free plan users need to upgrade to Starter or higher.
Q: I'm getting 422 Validation Error. What's wrong?
A: Your request has invalid data. Check the errors object in the response for details on which fields are invalid.
Q: I'm getting 429 Rate Limited. What should I do?
A: Wait for the reset time shown in the error response. Consider upgrading if you frequently hit limits.
Q: I'm getting 500 Server Error. What happened?
A: This is a temporary server issue. Retry your request after a few seconds. Contact support if it persists.
Integration & Development
Q: What programming languages are supported?
A: Any language that can make HTTP requests. We have examples for JavaScript, Python, and cURL.
Q: Can I use the API from a frontend application?
A: Yes, but be careful not to expose your token. For production, use a backend service to handle API requests.
Q: Is the API available in test/sandbox mode?
A: The API works the same in all environments. You can test with your actual account.
Q: Can I make requests from different origins?
A: Yes. The API supports CORS for frontend requests, but keep your token secure.
Q: What's the response time for API requests?
A: Most requests return in under 500ms. Heavy operations like screenshot downloads may take longer.
Billing & Subscription
Q: Do I pay per API request?
A: No. API access is included in your subscription. You pay a fixed monthly or yearly fee, not per request.
Q: What happens to my API access when my subscription expires?
A: You'll get 403 errors. API access is disabled until you renew your subscription.
Q: Can I upgrade/downgrade my plan anytime?
A: Yes. Changes take effect immediately. Upgrades are prorated; downgrades apply at the next billing cycle.
Q: Do I get a refund if I downgrade?
A: Downgrades apply at the next billing cycle. Mid-cycle downgrades are not refunded.
Support & Limits
Q: What's the maximum number of websites I can have?
A: It depends on your plan (1 for Free, 5 for Starter, 25 for Pro, 100 for Business).
Q: What's the maximum number of screenshots?
A: There's no strict limit, but daily and monthly limits apply based on your plan.
Q: How many team members can I invite?
A: It depends on your plan. Check the Team Users limit on the pricing page.
Q: Where can I get help?
A: You can:
Q: How do I report a bug?
A: Contact us with details about the issue, error messages, and your endpoint. Include your API version and plan type.
Still Have Questions?
If your question isn't answered here:
SnapTrack API