Metrics API

Endpoint Index

Action	Endpoint
Fetch GWP metrics	POST /business-stats/{tenantLocator}/metrics/gwp
Fetch Issued Policy Metrics	POST /business-stats/{tenantLocator}/metrics/issued
Fetch Priced Quote Metrics	POST /business-stats/{tenantLocator}/metrics/quotes
Fetch New Business Conversion Metrics	POST /business-stats/{tenantLocator}/metrics/conversionRate
Fetch Issued Renewal Metrics	POST /business-stats/{tenantLocator}/metrics/renewedPolicies
Fetch Expired Policy Metrics	POST /business-stats/{tenantLocator}/metrics/expiredPolicies
Fetch Renewal Conversion Metrics	POST /business-stats/{tenantLocator}/metrics/renewalRate
Download csv of GWP metrics	POST /business-stats/{tenantLocator}/metrics/gwp/download
Download csv of Issued Policy Metrics	POST /business-stats/{tenantLocator}/metrics/issued/download
Download csv of Priced Quote Metrics	POST /business-stats/{tenantLocator}/metrics/quotes/download
Download csv of New Business Conversion Metrics	POST /business-stats/{tenantLocator}/metrics/conversionRate/download
Download csv of Issued Renewal Metrics	POST /business-stats/{tenantLocator}/metrics/renewedPolicies/download
Download csv of Expired Policy Metrics	POST /business-stats/{tenantLocator}/metrics/expiredPolicies/download
Download csv of Renewal Conversion Metrics	POST /business-stats/{tenantLocator}/metrics/renewalRate/download

Metrics Data Reponse Endpoints

Fetch GWP metrics

getGWP

POST /business-stats/{tenantLocator}/metrics/gwp

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional
backfillZeroes	query	boolean?	optional

Request:MetricRequest
Response:MetricResponse
Security Group:metrics   Permission:read

Fetch Issued Policy Metrics

getIssuedPolicies

POST /business-stats/{tenantLocator}/metrics/issued

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional
backfillZeroes	query	boolean?	optional

Request:MetricRequest
Response:MetricResponse
Security Group:metrics   Permission:read

Fetch Priced Quote Metrics

getPricedQuotes

POST /business-stats/{tenantLocator}/metrics/quotes

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional
backfillZeroes	query	boolean?	optional

Request:MetricRequest
Response:MetricResponse
Security Group:metrics   Permission:read

Fetch New Business Conversion Metrics

getConversionRate

POST /business-stats/{tenantLocator}/metrics/conversionRate

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional
backfillZeroes	query	boolean?	optional

Request:MetricRequest
Response:MetricResponse
Security Group:metrics   Permission:read

Fetch Issued Renewal Metrics

getRenewedPolicies

POST /business-stats/{tenantLocator}/metrics/renewedPolicies

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional
backfillZeroes	query	boolean?	optional

Request:MetricRequest
Response:MetricResponse
Security Group:metrics   Permission:read

Fetch Expired Policy Metrics

getExpiredPolicies

POST /business-stats/{tenantLocator}/metrics/expiredPolicies

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional
backfillZeroes	query	boolean?	optional

Request:MetricRequest
Response:MetricResponse
Security Group:metrics   Permission:read

Fetch Renewal Conversion Metrics

getRenewalRate

POST /business-stats/{tenantLocator}/metrics/renewalRate

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional
backfillZeroes	query	boolean?	optional

Request:MetricRequest
Response:MetricResponse
Security Group:metrics   Permission:read

Metrics CSV Download Endpoints

Download csv of GWP metrics

downloadGWP

POST /business-stats/{tenantLocator}/metrics/gwp/download

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional
backfillZeroes	query	boolean?	optional

Request:MetricRequest
Response:StreamingResponseBody<string>
Security Group:metrics   Permission:read

Download csv of Issued Policy Metrics

downloadIssuedPolicies

POST /business-stats/{tenantLocator}/metrics/issued/download

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional
backfillZeroes	query	boolean?	optional

Request:MetricRequest
Response:StreamingResponseBody<string>
Security Group:metrics   Permission:read

Download csv of Priced Quote Metrics

downloadPricedQuotes

POST /business-stats/{tenantLocator}/metrics/quotes/download

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional
backfillZeroes	query	boolean?	optional

Request:MetricRequest
Response:StreamingResponseBody<string>
Security Group:metrics   Permission:read

Download csv of New Business Conversion Metrics

downloadConversionRate

POST /business-stats/{tenantLocator}/metrics/conversionRate/download

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional
backfillZeroes	query	boolean?	optional

Request:MetricRequest
Response:StreamingResponseBody<string>
Security Group:metrics   Permission:read

Download csv of Issued Renewal Metrics

downloadRenewedPolicies

POST /business-stats/{tenantLocator}/metrics/renewedPolicies/download

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional
backfillZeroes	query	boolean?	optional

Request:MetricRequest
Response:StreamingResponseBody<string>
Security Group:metrics   Permission:read

Download csv of Expired Policy Metrics

downloadExpiredPolicies

POST /business-stats/{tenantLocator}/metrics/expiredPolicies/download

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional
backfillZeroes	query	boolean?	optional

Request:MetricRequest
Response:StreamingResponseBody<string>
Security Group:metrics   Permission:read

Download csv of Renewal Conversion Metrics

downloadRenewalRate

POST /business-stats/{tenantLocator}/metrics/renewalRate/download

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional
backfillZeroes	query	boolean?	optional

Request:MetricRequest
Response:StreamingResponseBody<string>
Security Group:metrics   Permission:read

Metrics Request and Response Objects

MetricRequest

required
startTime datetime
endTime datetime
localEndDateAdjusted string
localStartDateAdjusted string

optional
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
count int
endDate string
offset int
periodic Enum none | day | week | month | quarter | year
startDate string
results DataPoint[]

DataPoint

required
tenantLocator uuid
productName string
currency string
dataPointStartDate string
value number

See Also

• Metrics Feature Guide