Get underwriting statistics

Retrieve dashboard statistics for the underwriting queue and processing metrics

Required Parameters

x-account-id   header string

Account ID for the request

Try it out

Loading...

Run Code (Cmd + Enter)Reset CodeVIM Disabled

Output:

Responses

200

Description

Successfully retrieved underwriting statistics

{
  "totalInQueue": 0,
  "pendingReview": 0,
  "awaitingDocuments": 0,
  "averageProcessingTime": 0,
  "todayProcessed": 0,
  "weeklyTrend": {
    "approved": 0,
    "declined": 0,
    "pending": 0
  }
}

401

Description

Authentication required

{
  "error": "Authentication required"
}

403

Description

Insufficient permissions

{
  "error": "readApplications permission is required"
}

500

Description

Internal server error

{
  "error": "Failed to get underwriting queue"
}

References

#/components/parameters/xAccountIdHeader#/components/schemas/UnderwritingStatistics#/components/responses/Unauthorized#/components/responses/Forbidden#/components/responses/InternalServerError

#/components/parameters/xAccountIdHeader

OpenAPI

in: header
name: x-account-id
schema:
  type: string
description: Account ID for the request
required: true
example: "2311"

TypeScript

|
export type xAccountIdHeader = any; // Schema type not fully supported

#/components/schemas/UnderwritingStatistics

OpenAPI

type: object
properties:
  totalInQueue:
    type: integer
    description: Total number of applications in the underwriting queue
  pendingReview:
    type: integer
    description: Number of applications awaiting initial review
  awaitingDocuments:
    type: integer
    description: Number of applications awaiting document verification
  averageProcessingTime:
    type: number
    format: float
    description: Average processing time in hours
  todayProcessed:
    type: integer
    description: Number of applications processed today
  weeklyTrend:
    type: object
    properties:
      approved:
        type: integer
        description: Number of applications approved this week
      declined:
        type: integer
        description: Number of applications declined this week
      pending:
        type: integer
        description: Number of applications with pending decisions this week
    required:
      - approved
      - declined
      - pending
required:
  - totalInQueue
  - pendingReview
  - awaitingDocuments
  - averageProcessingTime
  - todayProcessed
  - weeklyTrend

TypeScript

|
export interface UnderwritingStatistics {
  /** Total number of applications in the underwriting queue */
  totalInQueue: number;
  /** Number of applications awaiting initial review */
  pendingReview: number;
  /** Number of applications awaiting document verification */
  awaitingDocuments: number;
  /** Average processing time in hours */
  averageProcessingTime: number;
  /** Number of applications processed today */
  todayProcessed: number;
  weeklyTrend: { approved: number; declined: number; pending: number };
}

#/components/responses/Unauthorized

OpenAPI

description: Authentication required
content:
  application/json:
    schema:
      type: object
      properties:
        error:
          type: string
          example: Authentication required

TypeScript

|
export type Unauthorized = any; // Schema type not fully supported

#/components/responses/Forbidden

OpenAPI

description: Insufficient permissions
content:
  application/json:
    schema:
      type: object
      properties:
        error:
          type: string
          example: readApplications permission is required

TypeScript

|
export type Forbidden = any; // Schema type not fully supported

#/components/responses/InternalServerError

OpenAPI

description: Internal server error
content:
  application/json:
    schema:
      type: object
      properties:
        error:
          type: string
          example: Failed to get underwriting queue

TypeScript

|
export type InternalServerError = any; // Schema type not fully supported

Route Source Code

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

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

Required Parameters

Try it out

Responses

References

• components-parameters-xAccountIdHeader
• components-schemas-UnderwritingStatistics
• components-responses-Unauthorized
• components-responses-Forbidden
• components-responses-InternalServerError

Route Source Code