Omnix

ManagerDashboardRpc

This RPC group provides dashboard data for manager-facing views. It exposes read-only endpoints for retrieving active or scheduled campaigns, unassigned conversations, team open tickets, and unassigned tickets.

Endpoints

POST /api/rpc (Method: ManagerDashboardRpc.getCampaignOverview)

  • Description: Gets an overview of active and scheduled campaigns.

  • Request Body:

    {
      "method": "ManagerDashboardRpc.getCampaignOverview",
      "params": {}
    }
  • Parameters:

    Name Type Required Description
    None - No This method does not accept request parameters.
  • Response:

    {
      "success": true,
      "data": {
        // Response shape is returned by `CampaignService.getCampaigns(...)`.
        // The inspected source for `CampaignService` does not include this method,
        // so the exact payload structure cannot be confirmed here.
      }
    }
  • Example (cURL):

    curl -X POST "${APP_BASE_URL}/api/rpc" \
      -H "Content-Type: application/json" \
      -d '{
        "method": "ManagerDashboardRpc.getCampaignOverview",
        "params": {}
      }'

POST /api/rpc (Method: ManagerDashboardRpc.getUnassignedConversations)

  • Description: Gets all open, unassigned conversations.

  • Request Body:

    {
      "method": "ManagerDashboardRpc.getUnassignedConversations",
      "params": {}
    }
  • Parameters:

    Name Type Required Description
    None - No This method does not accept request parameters.
  • Response:

    {
      "success": true,
      "data": {
        "data": [
          {
            // Conversation objects returned by `UnifiedInboxService.getConversations(...)`
          }
        ],
        "totalCount": 0
      }
    }

    The service returns a paginated object with data and totalCount. Each conversation entry is enriched with contact information and an unreadCount value when available.

  • Example (cURL):

    curl -X POST "${APP_BASE_URL}/api/rpc" \
      -H "Content-Type: application/json" \
      -d '{
        "method": "ManagerDashboardRpc.getUnassignedConversations",
        "params": {}
      }'

POST /api/rpc (Method: ManagerDashboardRpc.getTeamOpenTickets)

  • Description: Gets all open tickets for the entire team.

  • Request Body:

    {
      "method": "ManagerDashboardRpc.getTeamOpenTickets",
      "params": {}
    }
  • Parameters:

    Name Type Required Description
    None - No This method does not accept request parameters.
  • Response:

    {
      "success": true,
      "data": {
        "data": [
          {
            // Ticket objects returned by `TicketService.getTickets(...)`
          }
        ],
        "totalCount": 0
      }
    }

    The service returns a paginated object with data and totalCount.

  • Example (cURL):

    curl -X POST "${APP_BASE_URL}/api/rpc" \
      -H "Content-Type: application/json" \
      -d '{
        "method": "ManagerDashboardRpc.getTeamOpenTickets",
        "params": {}
      }'

POST /api/rpc (Method: ManagerDashboardRpc.getUnassignedTickets)

  • Description: Gets all open tickets that are not assigned to any user.

  • Request Body:

    {
      "method": "ManagerDashboardRpc.getUnassignedTickets",
      "params": {}
    }
  • Parameters:

    Name Type Required Description
    None - No This method does not accept request parameters.
  • Response:

    {
      "success": true,
      "data": {
        "data": [
          {
            // Ticket objects returned by `TicketService.getTickets(...)`
          }
        ],
        "totalCount": 0
      }
    }

    The service returns a paginated object with data and totalCount.

  • Example (cURL):

    curl -X POST "${APP_BASE_URL}/api/rpc" \
      -H "Content-Type: application/json" \
      -d '{
        "method": "ManagerDashboardRpc.getUnassignedTickets",
        "params": {}
      }'