Metrics API
| Action | Endpoint |
|---|---|
| Fetch GWP metrics | POST/business-stats/metrics/gwp |
| Fetch Issued Policy Metrics | POST/business-stats/metrics/issued |
| Fetch Priced Quote Metrics | POST/business-stats/metrics/quotes |
| Fetch New Business Conversion Metrics | POST/business-stats/metrics/conversionRate |
| Fetch Issued Renewal Metrics | POST/business-stats/metrics/renewedPolicies |
| Fetch Expired Policy Metrics | POST/business-stats/metrics/expiredPolicies |
| Fetch Renewal Conversion Metrics | POST/business-stats/metrics/renewalRate |
| Download csv of GWP metrics | POST/business-stats/metrics/gwp/download |
| Download csv of Issued Policy Metrics | POST/business-stats/metrics/issued/download |
| Download csv of Priced Quote Metrics | POST/business-stats/metrics/quotes/download |
| Download csv of New Business Conversion Metrics | POST/business-stats/metrics/conversionRate/download |
| Download csv of Issued Renewal Metrics | POST/business-stats/metrics/renewedPolicies/download |
| Download csv of Expired Policy Metrics | POST/business-stats/metrics/expiredPolicies/download |
| Download csv of Renewal Conversion Metrics | POST/business-stats/metrics/renewalRate/download |
Metrics Data Response Endpoints
Fetch GWP metrics
Fetch GWP metrics
getGWPPOST
/business-stats/metrics/gwpParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
offset | query | integer? | No | |
count | query | integer? | No | |
backfillZeroes | query | boolean? | No |
Fetch Issued Policy Metrics
Fetch Issued Policy Metrics
getIssuedPoliciesPOST
/business-stats/metrics/issuedParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
offset | query | integer? | No | |
count | query | integer? | No | |
backfillZeroes | query | boolean? | No |
Fetch Priced Quote Metrics
Fetch Priced Quote Metrics
getPricedQuotesPOST
/business-stats/metrics/quotesParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
offset | query | integer? | No | |
count | query | integer? | No | |
backfillZeroes | query | boolean? | No |
Fetch New Business Conversion Metrics
Fetch New Business Conversion Metrics
getConversionRatePOST
/business-stats/metrics/conversionRateParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
offset | query | integer? | No | |
count | query | integer? | No | |
backfillZeroes | query | boolean? | No |
Fetch Issued Renewal Metrics
Fetch Issued Renewal Metrics
getRenewedPoliciesPOST
/business-stats/metrics/renewedPoliciesParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
offset | query | integer? | No | |
count | query | integer? | No | |
backfillZeroes | query | boolean? | No |
Fetch Expired Policy Metrics
Fetch Expired Policy Metrics
getExpiredPoliciesPOST
/business-stats/metrics/expiredPoliciesParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
offset | query | integer? | No | |
count | query | integer? | No | |
backfillZeroes | query | boolean? | No |
Fetch Renewal Conversion Metrics
Fetch Renewal Conversion Metrics
getRenewalRatePOST
/business-stats/metrics/renewalRateParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
offset | query | integer? | No | |
count | query | integer? | No | |
backfillZeroes | query | boolean? | No |
Metrics CSV Download Endpoints
Download csv of GWP metrics
Download csv of GWP metrics
downloadGWPPOST
/business-stats/metrics/gwp/downloadParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
offset | query | integer? | No | |
count | query | integer? | No | |
backfillZeroes | query | boolean? | No |
Download csv of Issued Policy Metrics
Download csv of Issued Policy Metrics
downloadIssuedPoliciesPOST
/business-stats/metrics/issued/downloadParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
offset | query | integer? | No | |
count | query | integer? | No | |
backfillZeroes | query | boolean? | No |
Download csv of Priced Quote Metrics
Download csv of Priced Quote Metrics
downloadPricedQuotesPOST
/business-stats/metrics/quotes/downloadParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
offset | query | integer? | No | |
count | query | integer? | No | |
backfillZeroes | query | boolean? | No |
Download csv of New Business Conversion Metrics
Download csv of New Business Conversion Metrics
downloadConversionRatePOST
/business-stats/metrics/conversionRate/downloadParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
offset | query | integer? | No | |
count | query | integer? | No | |
backfillZeroes | query | boolean? | No |
Download csv of Issued Renewal Metrics
Download csv of Issued Renewal Metrics
downloadRenewedPoliciesPOST
/business-stats/metrics/renewedPolicies/downloadParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
offset | query | integer? | No | |
count | query | integer? | No | |
backfillZeroes | query | boolean? | No |
Download csv of Expired Policy Metrics
Download csv of Expired Policy Metrics
downloadExpiredPoliciesPOST
/business-stats/metrics/expiredPolicies/downloadParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
offset | query | integer? | No | |
count | query | integer? | No | |
backfillZeroes | query | boolean? | No |
Download csv of Renewal Conversion Metrics
Download csv of Renewal Conversion Metrics
downloadRenewalRatePOST
/business-stats/metrics/renewalRate/downloadParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
offset | query | integer? | No | |
count | query | integer? | No | |
backfillZeroes | query | boolean? | No |
Metrics Request and Response Objects
MetricRequest
Required properties
| Property | Type | Description |
|---|---|---|
startTime | datetime | |
endTime | datetime | |
localEndDateAdjusted | date | |
localStartDateAdjusted | date |
Optional properties
| Property | Type | Description |
|---|---|---|
groupByProduct | boolean? | |
groupByTenant | boolean? | |
periodic | Enum? none | day | week | month | quarter | year | |
tenantType | Enum? test | production | retired | deleted | |
currencies | string[]? | |
products | string[]? | |
tenantLocators | uuid[]? |
MetricResponse
Required properties
| Property | Type | Description |
|---|---|---|
count | integer | |
endDate | date | |
offset | integer | |
periodic | Enum none | day | week | month | quarter | year | |
startDate | date | |
results | DataPoint[] |
DataPoint
Required properties
| Property | Type | Description |
|---|---|---|
tenantLocator | uuid | |
productName | string | |
currency | string | |
dataPointStartDate | date | |
value | number |