API Reference

Dashboard

List Users (Dashboard)

  • API Name: List Users for Dashboard
  • API Route: GET /api/v1/dashboard/users
  • Request:
    • Auth: Session required. Restricted to super_admin and super_user roles.
  • What it does: Returns a list of all users in the system with their basic info. Used to populate the user selection dropdown in the token usage dashboard.
  • Returns: Array of [ { "id", "name", "email" } ] sorted alphabetically by name. 403 for non-super-user roles.

Get Token Usage

  • API Name: Get Token Usage Metrics
  • API Route: GET /api/v1/dashboard/token-usage
  • Request:
    • Query Params:

- projectId (string, optional) — filter by project - workspaceId (string, optional) — filter by workspace - userId (string, optional) — super_users can filter by a specific user; other roles always see only their own data

  • What it does: Returns AI token usage metrics. Super users can view usage across all users or filter by a specific user. Non-super users always see only their own token usage.
  • Returns:
json
  {
    "totalTokens": number,
    "promptTokens": number,
    "completionTokens": number,
    "byModel": [ { "model", "tokens" } ],
    "byDate": [ { "date", "tokens" } ]
  }

Get Feedback Metrics

  • API Name: Get Feedback Metrics
  • API Route: GET /api/v1/dashboard/feedback
  • Request:
    • Query Params: projectId, workspaceId, userId (all optional)
    • Auth: Session required
  • What it does: Returns aggregated AI message feedback metrics (thumbs up/down counts, ratings) for the dashboard.
  • Returns: Feedback summary object with rating counts and distribution.

Get Activity Data

  • API Name: Get Activity Data
  • API Route: GET /api/v1/dashboard/activity
  • Request:
    • Query Params: limit (number, optional), offset (number, optional)
    • Auth: Session required
  • What it does: Returns recent activity data for display in the dashboard activity feed.
  • Returns: Array of recent activity entries.