Skip to content
Pulse Docs

GET   /api/dashboard/agent

Get Agent Dashboard Data

Retrieves comprehensive dashboard data for agent users including summary metrics, lead metrics, merchant portfolio, sales pipeline, and operational metrics

Optional Parameters

Click here to view an exhaustive list of all available parameters
timeRange   query string

Time range for dashboard data

compareMode   query string

Comparison mode for metrics

Try it out

Loading...

Output:

Responses

Description

Successfully retrieved agent dashboard data

{
  "summaryMetrics": {
    "totalProcessingVolume": 0,
    "totalTransactionCount": 0,
    "totalMerchants": 0,
    "activeLeads": 0,
    "conversionRate": 0,
    "residuals": 0,
    "changePercentages": {
      "volume": 0,
      "transactions": 0,
      "merchants": 0,
      "residuals": 0
    }
  },
  "leadMetrics": {
    "byStatus": [
      {
        "status": "string",
        "count": 0
      }
    ],
    "conversionTrend": [
      {
        "date": "string",
        "rate": 0
      }
    ],
    "bySources": [
      {
        "source": "string",
        "count": 0,
        "conversionRate": 0
      }
    ]
  },
  "merchantPortfolio": {
    "activeCount": 0,
    "volumeTrend": [
      {
        "date": "string",
        "volume": 0
      }
    ],
    "topMerchants": [
      {
        "id": "string",
        "name": "string",
        "volume": 0,
        "category": "string"
      }
    ]
  },
  "salesPipeline": {
    "applications": [
      {
        "id": "string",
        "merchantName": "string",
        "stage": "string",
        "submissionDate": "string",
        "projectedVolume": 0
      }
    ],
    "approvalRate": 0
  },
  "operationalMetrics": {
    "equipmentInventory": {
      "available": 0,
      "deployed": 0,
      "maintenance": 0
    },
    "supportTickets": 0,
    "trainingCompliance": 0
  }
}

Or the swagger.yaml spec this documentation was generated from: /dashboard/agent/swagger.yaml