SigSentry Documentation

Current quota status — month-to-date count, plan limit, projection, and breakdowns

Returns the tenant's current quota status: how many analyses you've run this calendar month, the plan limit, an end-of-month projection extrapolated from your daily rate, and breakdowns by project and severity.

Counts are tenant-wide and roll over at the start of each calendar month (UTC).

Authentication

API key with config:read permission.

Endpoint

GET /v1/config/usage

Response

200 OK

{
  "success": true,
  "data": {
    "analysesThisMonth": 312,
    "planLimit": 500,
    "projectedEndOfMonth": 480,
    "daysRemaining": 5,
    "byProject": [
      { "projectId": "6f1c89bb-...", "projectName": "Checkout API", "count": 240 },
      { "projectId": "9a2e7cf3-...", "projectName": "Auth Service", "count": 72 }
    ],
    "bySeverity": {
      "critical": 12,
      "high": 88,
      "medium": 142,
      "low": 60,
      "info": 10
    },
    "dailyTrend": [
      { "date": "2026-03-27", "count": 9 },
      { "date": "2026-03-28", "count": 14 },
      { "date": "2026-04-25", "count": 11 }
    ]
  }
}

Field	Type	Notes
`analysesThisMonth`	int	Analyses created since the start of the current calendar month (UTC)
`planLimit`	int	Monthly analysis allowance for your current plan
`projectedEndOfMonth`	int	An end-of-month projection based on recent usage
`daysRemaining`	int	Calendar days left in the current month
`byProject`	array	One entry per project with at least one analysis this month
`byProject[].projectId`	UUID	The project id
`byProject[].projectName`	string	The project's display name
`byProject[].count`	int	Analyses run against that project this month
`bySeverity`	object	Map of severity → count, for analyses this month
`dailyTrend`	array	Per-day analysis counts for the last 30 days; days with zero are omitted
`dailyTrend[].date`	string (`YYYY-MM-DD`)	Calendar date (UTC)
`dailyTrend[].count`	int	Analyses created that day

What "exceeded the limit" means

analysesThisMonth > planLimit doesn't fail this endpoint — usage keeps incrementing past the plan limit. What happens to new analysis requests when you exceed the limit depends on whether overage is enabled for your tenant. See Overage for the full behavior.

Error responses

Status	`error.code`	When
401	`UNAUTHORIZED`	Missing or invalid API key
403	`FORBIDDEN`	Key lacks `config:read`

Example

curl https://api.sigsentry.com/v1/config/usage \
  -H "Authorization: Bearer ss_secret_..."

GET /v1/config/usage