API Reference
Overview
Snapshot API Documentation Overview
Welcome to the Snapshot API documentation. This reference provides everything you need to authenticate your requests, capture and manage website screenshots, automate recurring captures with schedules, track screenshot and account activity and generate downloadable reports. Use the sections below to explore each API group and access detailed endpoint documentation, including request parameters, authentication requirements and response information.
Quick Start
- Obtain API Key
- Authenticate API requests
- Capture first screenshot
- Retrieve screenshot details
- Optionally create recurring schedules
- Monitor activity and generate reports
Authentication
Authenticate every request with your workspace API key before using any Snapshot endpoint.
Screenshot API
- Capture Screenshot
Capture high-quality website screenshots programmatically.
- Screenshot Details
Fetch screenshot metadata, processing details, and result URLs.
Screenshot Scheduling
- Create Schedule
Create a recurring or one-time screenshot schedule.
- List Schedules
List existing schedules in your workspace.
- Get Schedule by ID
Read schedule configuration and status details.
- Update Schedule
Update schedule configuration and timing.
- Delete Schedule
Delete a schedule that is no longer required.
- Add Schedule Items
Add new URL capture items to an existing schedule.
- Delete Schedule Item
Remove a schedule item from a schedule.
- List Schedule Executions
Review execution history for schedule runs.
- Get Schedule Execution
Inspect one execution with detailed run results.
Activity API
- Screenshot Activity
Review screenshot-level operational activity.
- Wallet Activity
Track credit deductions and wallet transactions.
- Content Change Activity
Track website content-change detection operations.
Reports API
- Generate Screenshot Report
Generate screenshot reports for selected data ranges.
- List Reports
List generated reports and fetch downloadable report details.