Get application statistics

Retrieve comprehensive application statistics for the account including approval rates, processing times, and volume metrics. Requires readApplications permission.

Try it out

Loading...

Run Code (Cmd + Enter)Reset CodeVIM Disabled

Output:

Responses

200

Description

Statistics retrieved successfully

{
  "summaryMetrics": {
    "totalApplications": 0,
    "pendingApplications": 0,
    "approvedThisMonth": 0,
    "approvalRate": 0,
    "averageProcessingTime": 0,
    "changePercentages": {
      "applications": 0,
      "approvalRate": 0,
      "processingTime": 0
    }
  },
  "applicationsByStatus": [
    {
      "status": "string",
      "count": 0,
      "percentage": 0
    }
  ],
  "applicationsByIndustry": [
    {
      "industry": "string",
      "count": 0,
      "approvalRate": 0
    }
  ],
  "processingVolume": [
    {
      "month": "string",
      "submitted": 0,
      "approved": 0,
      "declined": 0
    }
  ],
  "recentApplications": [
    {
      "uniqueId": "string",
      "dbaName": "string",
      "status": "string",
      "submittedDate": "string",
      "assignedTo": "string",
      "processingTime": 0
    }
  ],
  "topAgents": [
    {
      "name": "string",
      "applications": 0,
      "approvalRate": 0
    }
  ]
}

403

Description

Insufficient permissions

References

#/components/schemas/ApplicationStatistics

#/components/schemas/ApplicationStatistics

OpenAPI

type: object
properties:
  summaryMetrics:
    type: object
    properties:
      totalApplications:
        type: integer
        description: Total number of applications
      pendingApplications:
        type: integer
        description: Number of applications in review states
      approvedThisMonth:
        type: integer
        description: Number of applications approved this month
      approvalRate:
        type: number
        description: Overall approval rate (percentage)
      averageProcessingTime:
        type: number
        description: Average processing time in days
      changePercentages:
        type: object
        properties:
          applications:
            type: number
            description: Month-over-month percentage change in new applications
          approvalRate:
            type: number
            description: Month-over-month percentage change in approval rate
          processingTime:
            type: number
            description: Month-over-month percentage change in processing time
    description: High-level summary metrics
  applicationsByStatus:
    type: array
    items:
      type: object
      properties:
        status:
          type: string
          enum:
            - DRAFT
            - INCOMPLETE
            - PENDING_COMPLETION
            - COMPLETED
            - INITIAL_REVIEW
            - DOCUMENTATION_REVIEW
            - PENDING_INFORMATION
            - TRIAGED
            - IN_UNDERWRITING
            - VERIFICATION_PENDING
            - ADDITIONAL_REVIEW_REQUIRED
            - UNDERWRITING_HOLD
            - SUBMITTED
            - APPROVED
            - CONDITIONALLY_APPROVED
            - DECLINED
            - WITHDRAWN
            - ACCOUNT_SETUP
            - TESTING
            - PENDING_GO_LIVE
            - ACTIVE
            - ON_HOLD
            - UNDER_REVIEW
            - SUSPENDED
            - TERMINATED
            - TIMEOUT
          description: Application state
        count:
          type: integer
          description: Number of applications in this state
        percentage:
          type: number
          description: Percentage of total applications in this state
    description: Application distribution by status
  applicationsByIndustry:
    type: array
    items:
      type: object
      properties:
        industry:
          type: string
          description: Industry type or MCC category
        count:
          type: integer
          description: Number of applications from this industry
        approvalRate:
          type: number
          description: Approval rate for this industry (percentage)
    description: Top 6 industries with performance metrics
  processingVolume:
    type: array
    items:
      type: object
      properties:
        month:
          type: string
          description: Month label (e.g., "Jan 2025")
        submitted:
          type: integer
          description: Applications submitted in this month
        approved:
          type: integer
          description: Applications approved in this month
        declined:
          type: integer
          description: Applications declined in this month
    description: Last 5 months of processing volume
  recentApplications:
    type: array
    items:
      type: object
      properties:
        uniqueId:
          type: string
          description: Application unique ID
        dbaName:
          type: string
          description: Business DBA name
        status:
          type: string
          description: Current application state
        submittedDate:
          type: string
          format: date-time
          description: Last updated date
        assignedTo:
          type: string
          description: User assigned to this application
        processingTime:
          type: number
          description: Processing time in days
    description: 5 most recently updated applications
  topAgents:
    type: array
    items:
      type: object
      properties:
        name:
          type: string
          description: Agent name
        applications:
          type: integer
          description: Number of applications handled
        approvalRate:
          type: number
          description: Approval rate for this agent (percentage)
    description: Top 4 agents by application count

TypeScript

|
export interface ApplicationStatistics {
  /** High-level summary metrics */
  summaryMetrics?: {
    totalApplications?: number;
    pendingApplications?: number;
    approvedThisMonth?: number;
    approvalRate?: number;
    averageProcessingTime?: number;
    changePercentages?: {
      applications?: number;
      approvalRate?: number;
      processingTime?: number;
    };
  };
  /** Application distribution by status */
  applicationsByStatus?: {
    status?:
      | "DRAFT"
      | "INCOMPLETE"
      | "PENDING_COMPLETION"
      | "COMPLETED"
      | "INITIAL_REVIEW"
      | "DOCUMENTATION_REVIEW"
      | "PENDING_INFORMATION"
      | "TRIAGED"
      | "IN_UNDERWRITING"
      | "VERIFICATION_PENDING"
      | "ADDITIONAL_REVIEW_REQUIRED"
      | "UNDERWRITING_HOLD"
      | "SUBMITTED"
      | "APPROVED"
      | "CONDITIONALLY_APPROVED"
      | "DECLINED"
      | "WITHDRAWN"
      | "ACCOUNT_SETUP"
      | "TESTING"
      | "PENDING_GO_LIVE"
      | "ACTIVE"
      | "ON_HOLD"
      | "UNDER_REVIEW"
      | "SUSPENDED"
      | "TERMINATED"
      | "TIMEOUT";
    count?: number;
    percentage?: number;
  }[];
  /** Top 6 industries with performance metrics */
  applicationsByIndustry?: {
    industry?: string;
    count?: number;
    approvalRate?: number;
  }[];
  /** Last 5 months of processing volume */
  processingVolume?: {
    month?: string;
    submitted?: number;
    approved?: number;
    declined?: number;
  }[];
  /** 5 most recently updated applications */
  recentApplications?: {
    uniqueId?: string;
    dbaName?: string;
    status?: string;
    submittedDate?: Date;
    assignedTo?: string;
    processingTime?: number;
  }[];
  /** Top 4 agents by application count */
  topAgents?: { name?: string; applications?: number; approvalRate?: number }[];
}

Route Source Code

Check out the source code for this route entrypoint here: /applications/statistics/route.ts

Or the swagger.yaml spec this documentation was generated from: /applications/statistics/swagger.yaml

Try it out

Responses

References

• components-schemas-ApplicationStatistics

Route Source Code