---
title: "CaseStatsSearchModel"
url: "https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086/schemas/CaseStatsSearchModel"
---

> Full API specification: https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086.md

# CaseStatsSearchModel

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Policy Service
  version: 0.0.21
servers:
  - url: https://qa.api.zinnia.io
components:
  schemas:
    InstanceExceptionModel:
      type: object
      properties:
        id:
          type: string
          description: Exception identifier
          example: exc-123
        externalId:
          type: string
          description: External identifier for the exception
          example: EXT-123
        status:
          type: string
          description: Current status of the exception
          example: Open
        category:
          type: string
          description: Exception category
          example: Documentation
        exceptionType:
          type: string
          description: Type of exception
          example: Technical
        reason:
          type: string
          description: Brief reason for the exception
          example: Missing document
        detailedReason:
          type: string
          description: Detailed description of the exception reason
          example: Signature missing on page 3 of application form
        processingReason:
          type: string
          description: Processing reason for the exception
          example: Requires manual review
        processingResolution:
          type: string
          description: Resolution details for processing
          example: Document resent by applicant
        createdAt:
          type: string
          description: Date when the exception was created
          example: 2023-01-15T10:30:00Z
        updatedAt:
          type: string
          description: Date when the exception was last updated
          example: 2023-01-16T14:45:00Z
    IdentifierDocument:
      type: object
      properties:
        identifier:
          type: string
          description: Type of identifier
          example: SSN
        value:
          type: string
          description: Value of the identifier
          example: 123-45-6789
    CaseStatsSearchModel:
      type: object
      properties:
        applicationType:
          type: string
          description: Type of application
        policyNumber:
          type: string
          description: Policy number to search for
          example: POL123456789
        requestSubType:
          description: List of request sub-types to filter by
          type: array
          items:
            type: string
        productName:
          description: List of product names to filter by
          type: array
          items:
            type: string
        ssn:
          type: string
          description: Social Security Number of policy owner
        ownerName:
          type: string
          description: Full name of the policy owner
          example: John Doe
        ownerFirstName:
          type: string
          description: First name of policy owner
          example: John
        ownerLastName:
          type: string
          description: Last name of policy owner
          example: Doe
        process:
          description: List of processes to filter by
          type: array
          items:
            type: string
        carrier:
          description: List of carriers to filter by
          example:
            - EVGL
          type: array
          items:
            type: string
        caseStatus:
          description: List of case statuses to filter by
          type: array
          items:
            type: string
        createdDateStart:
          format: date-time
          type: string
          description: Start date for filtering by case creation date
          example: 2023-01-01T00:00:00Z
        createdDateEnd:
          format: date-time
          type: string
          description: End date for filtering by case creation date
          example: 2023-12-31T23:59:59Z
        updatedDateStart:
          format: date-time
          type: string
          description: Start date for filtering by case update date
          example: 2023-01-01T00:00:00Z
        updatedDateEnd:
          format: date-time
          type: string
          description: End date for filtering by case update date
          example: 2023-12-31T23:59:59Z
        agentFirstName:
          type: string
          description: First name of the agent
          example: Jane
        agentLastName:
          type: string
          description: Last name of the agent
          example: Smith
        agentSsn:
          type: string
          description: Social Security Number of agent
        brokerDealerName:
          type: string
          description: Name of the broker-dealer
          example: ABC Financial Services
        caseIds:
          description: List of case IDs to search for
          example:
            - CASE123
            - CASE456
          type: array
          items:
            type: string
        sortBy:
          type: string
          description: Field to sort results by
          example: createdAt
        sortDirection:
          type: string
          description: Direction of sorting (asc or desc)
          example: desc
          enum:
            - asc
            - desc
        offset:
          type: string
          description: Offset for pagination
          example: "0"
        limit:
          type: string
          description: Limit for pagination - number of results to return
          example: "25"
        notInCaseStatus:
          description: List of case statuses to exclude from results
          type: array
          items:
            type: string
        isIncludeSecondary:
          type: boolean
          description: Whether to include secondary cases
          example: true
        primary:
          type: boolean
          description: Flag to filter for primary cases only
          example: true
        exceptions:
          description: List of exceptions to search for
          type: array
          items:
            $ref: "#/components/schemas/InstanceExceptionModel"
        identifiers:
          description: List of identifiers to search for
          type: array
          items:
            $ref: "#/components/schemas/IdentifierDocument"
        issueStatus:
          description: List of exception statuses to search for
          type: array
          items:
            type: string
        escalated:
          type: boolean
          description: Flag to filter for escalated cases only
          example: true
        caseGroups:
          description: List of case groups to search for
          type: array
          items:
            type: string
        groupBy:
          type: array
          description: List of fields to group by
          example:
            - caseStatus
          items:
            type: string
            enum:
              - policyNumber
              - ssn
              - ownerName
              - process
              - carrier
              - caseStatus
              - applicationType
      required:
        - groupBy
```