Omnix

AdminDashboardRpc

This RPC class provides a small dashboard-oriented API that forwards requests to other RPC endpoints. It exposes summary and breakdown calls for AI usage, plus a channel health lookup, without adding its own data shaping beyond parameter forwarding.

Endpoints

POST /api/rpc (Method: AdminDashboardRpc.getAiUsageSummary)

This method acts as a facade for AdminAnalyticsRpc.getOverallUsageSummary and forwards the request parameters and context unchanged.

  • Description: Facade for AdminAnalyticsRpc.getOverallUsageSummary.
  • Request Body:
    {
      "method": "AdminDashboardRpc.getAiUsageSummary",
      "params": {}
    }
  • Parameters:
    Name Type Required Description
    params Object No No fields are defined by the schema.
  • Response:
    {
      "success": true,
      "data": {
        "/* response is returned directly from `AdminAnalyticsRpc.getOverallUsageSummary` */": true
      }
    }
  • Example (cURL):
    curl -X POST "${APP_BASE_URL}/api/rpc" \
      -H "Content-Type: application/json" \
      -d '{
        "method": "AdminDashboardRpc.getAiUsageSummary",
        "params": {}
      }'

POST /api/rpc (Method: AdminDashboardRpc.getAiUsageByModel)

This method forwards a groupBy value to AdminAnalyticsRpc.getUsageData and returns that RPC's result directly.

  • Description: Facade for AdminAnalyticsRpc.getUsageData.
  • Request Body:
    {
      "method": "AdminDashboardRpc.getAiUsageByModel",
      "params": {
        "groupBy": "string"
      }
    }
  • Parameters:
    Name Type Required Description
    groupBy String Yes Grouping key passed through to AdminAnalyticsRpc.getUsageData.
  • Response:
    {
      "success": true,
      "data": {
        "/* response is returned directly from `AdminAnalyticsRpc.getUsageData` */": true
      }
    }
  • Example (cURL):
    curl -X POST "${APP_BASE_URL}/api/rpc" \
      -H "Content-Type: application/json" \
      -d '{
        "method": "AdminDashboardRpc.getAiUsageByModel",
        "params": {
          "groupBy": "model"
        }
      }'

POST /api/rpc (Method: AdminDashboardRpc.getChannelHealth)

This method acts as a facade for ChannelManagerRpc.getData and returns its result directly.

  • Description: Facade for ChannelManagerRpc.getData.
  • Request Body:
    {
      "method": "AdminDashboardRpc.getChannelHealth",
      "params": {}
    }
  • Parameters:
    Name Type Required Description
    params Object No No fields are defined by the schema.
  • Response:
    {
      "success": true,
      "data": {
        "/* response is returned directly from `ChannelManagerRpc.getData` */": true
      }
    }
  • Example (cURL):
    curl -X POST "${APP_BASE_URL}/api/rpc" \
      -H "Content-Type: application/json" \
      -d '{
        "method": "AdminDashboardRpc.getChannelHealth",
        "params": {}
      }'