CentralCSP
APIUsage

Get workspace usage

Returns how many reports the workspace has accepted this period, its plan limit, and whether its subscription is active. A period is a calendar month in UTC. Once the limit is reached, every website in the workspace stops collecting until the next period.

Requires membership of the workspace.

GET
/v1/workspaces/{workspaceId}/usage

Authorization

headerAuthorizationBearer <JWT>

An OpenID Connect access token from signing in to CentralCSP, acting as the signed-in user.

Path Parameters

workspaceId*string

The workspace's id.

Response Body

A workspace's usage this period.

application/json
  1. response
workspaceId*string

The workspace.

period*string

The usage period, as a UTC calendar month.

hasActiveSubscription*boolean

When false, the workspace collects nothing, whatever the counter says.

limit*||

Reports the plan allows this period. null means the plan sets no limit.

usage*|

Reports accepted so far this period.

Range0 <= value
Example Request
curl -X GET 'https://api.centralcsp.com/v1/workspaces/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90/usage'
Example Response
{  "workspaceId": "string",  "period": "2026-01",  "hasActiveSubscription": true,  "limit": 0,  "usage": 0}