Analyses
GET /v1/analyses
List analyses for a project with filtering and pagination
Returns a paginated list of analyses for the current project, ordered by most-recent first.
Authentication
API key with analysis:read permission. Project-scoped or
tenant-scoped (with X-Project-Id).
Endpoint
GET /v1/analysesQuery parameters
| Param | Type | Default | Notes |
|---|---|---|---|
page | int ≥ 1 | 1 | 1-indexed page number |
limit | int 1–100 | 20 | Items per page |
status | 'pending' | 'processing' | 'complete' | 'partial' | 'failed' | — | Filter by lifecycle status |
severity | 'critical' | 'high' | 'medium' | 'low' | 'info' | — | Filter by severity |
fromDate | string (ISO 8601) | — | Only analyses created at or after this time |
toDate | string (ISO 8601) | — | Only analyses created strictly before this time |
fromDate/toDate apply to the analysis createdAt field.
Response
200 OK
{
"success": true,
"data": {
"items": [
{
"id": "ana_x1y2...",
"status": "complete",
"severity": "high",
"summary": "Connection pool exhaustion...",
"createdAt": "2026-04-25T14:30:12Z",
"timeStart": "2026-04-25T14:00:00Z",
"timeEnd": "2026-04-25T14:30:00Z",
"description": "Checkout 500s spiked after 14:00"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 47,
"totalPages": 3
}
}
}Items contain only the summary fields. Fetch
GET /v1/analyses/{id} for the full result.
Error responses
| Status | error.code | When |
|---|---|---|
| 400 | VALIDATION_ERROR | A query param failed validation |
| 400 | INVALID_TIME_RANGE | toDate is not after fromDate |
| 401 | UNAUTHORIZED | Missing or invalid API key |
| 403 | FORBIDDEN | Key lacks analysis:read |
Example
curl "https://api.sigsentry.com/v1/analyses?severity=high&limit=50" \
-H "Authorization: Bearer ss_secret_..."See Pagination for the iteration pattern.
