Policy
PolicyStatGroup
objectattributestringrequired
The attribute this group breaks down by
Allowed values:carrierproductNamelineOfBusinesspolicyStatus
Example:carrier
countsarray[object]required
Count breakdown for this attribute
Default:[]
Show Child Parameters
Example
PolicyStatsResponse
objectcountnumberrequired
Total count of policies matching the search criteria
Example:344
ageBucketsarray[object]
Policies grouped by age in days (returned when timePeriod is not provided)
Show Child Parameters
timePeriodstring
Time period used for grouping (YEARLY, HALF_YEARLY, QUARTERLY, MONTHLY)
Allowed values:YEARLYHALF_YEARLYQUARTERLYMONTHLY
timeGroupsarray[object]
Policies grouped by time period buckets (returned when timePeriod is provided)
Show Child Parameters
statsarray[object]required
Policy counts grouped by requested dimensions
Default:[]
Show Child Parameters
Example
Url
objectwebsitestring
Carrier or Third party administrator website
Example:https://zinnialive.com/
carrierLoginstring
Carrier login
Example:https://zinnialive.com/
agentLoginstring
Agent login
Example:https://zinnialive.com/
customerLoginstring
Customer login
Example:https://wellabe.mypolicyview.com/
Example
EntityType
stringAllowed values:SOLEPROPRIETORSHIPGENERALPARTNERSHIPLIMITEDPARTNERSHIPCCORPORATIONSCORPORATIONLIMITEDLIABILITYCOMPANYCHARITABLEORGANIZATIONESTATETRUSTCORPORATIONUNKNOWN
CommunicationType
stringAllowed values:EMAILREGULARMAILPHONEFAXTEXTNOPREFERENCESPECIFIEDPOSTALOTHER