Get snapshots
archivebox_get_snapshotsRetrieve and filter archived snapshots by ID, URL, tag, title, creator, or date, with search and pagination support.
Instructions
Retrieve list of snapshots
Args: id: Filter by snapshot ID. abid: Filter by snapshot abid. created_by_id: Filter by creator ID. created_by_username: Filter by creator username. created_at__gte: Filter by creation date >= (ISO 8601 format). created_at__lt: Filter by creation date < (ISO 8601 format). created_at: Filter by exact creation date (ISO 8601 format). modified_at: Filter by exact modification date (ISO 8601 format). modified_at__gte: Filter by modification date >= (ISO 8601 format). modified_at__lt: Filter by modification date < (ISO 8601 format). search: Search across url, title, tags, id, abid, timestamp. url: Filter by URL (exact). tag: Filter by tag name (exact). title: Filter by title (icontains). timestamp: Filter by timestamp (startswith). bookmarked_at__gte: Filter by bookmark date >= (ISO 8601 format). bookmarked_at__lt: Filter by bookmark date < (ISO 8601 format). with_archiveresults: Include archiveresults in response. limit: Number of results to return. offset: Offset for pagination. page: Page number for pagination. api_key: API key for QueryParamTokenAuth (optional).
Returns: Response: The response object from the GET request.
Raises: ParameterError: If the provided parameters are invalid.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| tag | No | ||
| url | No | ||
| abid | No | ||
| page | No | ||
| limit | No | ||
| title | No | ||
| offset | No | ||
| search | No | ||
| api_key | No | ||
| timestamp | No | ||
| created_at | No | ||
| modified_at | No | ||
| created_by_id | No | ||
| created_at__lt | No | ||
| created_at__gte | No | ||
| modified_at__lt | No | ||
| modified_at__gte | No | ||
| bookmarked_at__lt | No | ||
| bookmarked_at__gte | No | ||
| created_by_username | No | ||
| with_archiveresults | No |