List snapshotted issues for an audit
Retrieves a list of snapshots that have been shared with an audit.
The snapshots returned contain metadata about point-in-time captures of issues for an audit. This data can be used to filter down the list of issues to specific snapshots when querying the GET /audits/{auditId}/issues/items endpoint.
Supports filtering by:
- search: full text search across snapshot title and description
Results are sorted by snapshot creation date in descending order (newest first).
Uses cursor-based pagination. To paginate:
- Make initial request with desired pageSize
- Check results.pageInfo.hasNextPage
- Use results.pageInfo.endCursor as pageCursor for next request
Rate limit: 10 requests / minute.
Path parameters
The audit ID
Query parameters
Controls the maximum number of items returned in one response from the API.
Maximum number of results per page (1-100, default 10)
A marker or pointer, telling the API where to start fetching items for the subsequent page in a paginated dataset. Note that the requested page will not include the item that corresponds to this cursor but will start from the one immediately after this cursor.
Pagination cursor from previous response
Search term for filtering by snapshot title and description
Response
Ok
Example response
{
"results": {
"data": [
{
"id": "5f2c939a52855e725c8d5823",
"title": "Snapshot taken on 2024-06-01T00:00:00Z",
"description": "This snapshot captures all open issues as of June 1st, 2024.",
"createdAt": "2024-06-01T00:00:00.000Z"
}
]
}
}