Skip to content

Workspace Analytics

Get an analytics overview of AI usage within a workspace.

Endpoints

MethodPathDescriptionAuthRate Limit
GET/workspaces/:workspaceId/ai/analytics/overviewAnalytics overviewJWT + Entitlement30/min

Analytics Overview

Request

  • Path params: workspaceId — the workspace you want analytics for

Response

json
{
  "data": {
    "workspaceId": "cm5ws01",
    "period": "2026-03",
    "totalRuns": 142,
    "totalTokensUsed": 285000,
    "totalCreditsConsumed": 57,
    "activeAgents": 3,
    "activeTwins": 2,
    "topFeatures": [
      { "featureKey": "chain-coach", "runs": 65 },
      { "featureKey": "bit-decomposer", "runs": 42 }
    ],
    "dailyUsage": [
      { "date": "2026-03-17", "runs": 8, "tokensUsed": 16000 }
    ]
  }
}

Code Examples

Use the id of the workspace you want analytics for as $WORKSPACE_ID.

bash
curl https://api.chainabit.com/api/v1/workspaces/$WORKSPACE_ID/ai/analytics/overview \
  -H "Authorization: Bearer $TOKEN"
javascript
const BASE_URL = process.env.BASE_URL;
const TOKEN = process.env.TOKEN;
const workspaceId = process.env.WORKSPACE_ID; // the workspace to report on

const response = await fetch(
  `${BASE_URL}/workspaces/${workspaceId}/ai/analytics/overview`,
  { headers: { Authorization: `Bearer ${TOKEN}` } }
);
const { data } = await response.json();
python
import requests, os

workspace_id = os.environ["WORKSPACE_ID"]  # the workspace to report on
response = requests.get(
    f"{os.environ['BASE_URL']}/workspaces/{workspace_id}/ai/analytics/overview",
    headers={"Authorization": f"Bearer {os.environ['TOKEN']}"},
)
data = response.json()["data"]

Built with purpose.