CentralCSP
APIUsage

Get website usage

Returns how many reports this website has accepted this period and the limit set on it. A null limit means only the workspace limit applies.

Requires the viewer role on the website.

GET
/v1/workspaces/{workspaceId}/websites/{websiteId}/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.

websiteId*string

The website's id.

Response Body

A website's usage this period.

application/json
  1. response
websiteId*string

The website.

period*string

The usage period, as a UTC calendar month.

limit*||

The cap set on this website. null means only the workspace limit applies.

usage*|

Reports accepted for this website so far this period.

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

Get workspace usage GET

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.

Set a website usage limit PUT

Caps how many reports this website may accept per period. Send null to remove the cap. The limit cannot be higher than the workspace plan limit.