# Metrics API



<EndpointIndex
  names={[
  	'getGWP',
  	'getIssuedPolicies',
  	'getPricedQuotes',
  	'getConversionRate',
  	'getRenewedPolicies',
  	'getExpiredPolicies',
  	'getRenewalRate',
  	'downloadGWP',
  	'downloadIssuedPolicies',
  	'downloadPricedQuotes',
  	'downloadConversionRate',
  	'downloadRenewedPolicies',
  	'downloadExpiredPolicies',
  	'downloadRenewalRate',
  ]}
  titles={{
  	getGWP: 'Fetch GWP metrics',
  	getIssuedPolicies: 'Fetch Issued Policy Metrics',
  	getPricedQuotes: 'Fetch Priced Quote Metrics',
  	getConversionRate: 'Fetch New Business Conversion Metrics',
  	getRenewedPolicies: 'Fetch Issued Renewal Metrics',
  	getExpiredPolicies: 'Fetch Expired Policy Metrics',
  	getRenewalRate: 'Fetch Renewal Conversion Metrics',
  	downloadGWP: 'Download csv of GWP metrics',
  	downloadIssuedPolicies: 'Download csv of Issued Policy Metrics',
  	downloadPricedQuotes: 'Download csv of Priced Quote Metrics',
  	downloadConversionRate: 'Download csv of New Business Conversion Metrics',
  	downloadRenewedPolicies: 'Download csv of Issued Renewal Metrics',
  	downloadExpiredPolicies: 'Download csv of Expired Policy Metrics',
  	downloadRenewalRate: 'Download csv of Renewal Conversion Metrics',
  }}
/>

Metrics Data Response Endpoints [#metrics-data-response-endpoints]

Fetch GWP metrics [#fetch-gwp-metrics]

<ApiEndpoint name="getGWP" title="Fetch GWP metrics" />

Fetch Issued Policy Metrics [#fetch-issued-policy-metrics]

<ApiEndpoint name="getIssuedPolicies" title="Fetch Issued Policy Metrics" />

Fetch Priced Quote Metrics [#fetch-priced-quote-metrics]

<ApiEndpoint name="getPricedQuotes" title="Fetch Priced Quote Metrics" />

Fetch New Business Conversion Metrics [#fetch-new-business-conversion-metrics]

<ApiEndpoint name="getConversionRate" title="Fetch New Business Conversion Metrics" />

Fetch Issued Renewal Metrics [#fetch-issued-renewal-metrics]

<ApiEndpoint name="getRenewedPolicies" title="Fetch Issued Renewal Metrics" />

Fetch Expired Policy Metrics [#fetch-expired-policy-metrics]

<ApiEndpoint name="getExpiredPolicies" title="Fetch Expired Policy Metrics" />

Fetch Renewal Conversion Metrics [#fetch-renewal-conversion-metrics]

<ApiEndpoint name="getRenewalRate" title="Fetch Renewal Conversion Metrics" />

Metrics CSV Download Endpoints [#metrics-csv-download-endpoints]

Download csv of GWP metrics [#download-csv-of-gwp-metrics]

<ApiEndpoint name="downloadGWP" title="Download csv of GWP metrics" />

Download csv of Issued Policy Metrics [#download-csv-of-issued-policy-metrics]

<ApiEndpoint name="downloadIssuedPolicies" title="Download csv of Issued Policy Metrics" />

Download csv of Priced Quote Metrics [#download-csv-of-priced-quote-metrics]

<ApiEndpoint name="downloadPricedQuotes" title="Download csv of Priced Quote Metrics" />

Download csv of New Business Conversion Metrics [#download-csv-of-new-business-conversion-metrics]

<ApiEndpoint name="downloadConversionRate" title="Download csv of New Business Conversion Metrics" />

Download csv of Issued Renewal Metrics [#download-csv-of-issued-renewal-metrics]

<ApiEndpoint name="downloadRenewedPolicies" title="Download csv of Issued Renewal Metrics" />

Download csv of Expired Policy Metrics [#download-csv-of-expired-policy-metrics]

<ApiEndpoint name="downloadExpiredPolicies" title="Download csv of Expired Policy Metrics" />

Download csv of Renewal Conversion Metrics [#download-csv-of-renewal-conversion-metrics]

<ApiEndpoint name="downloadRenewalRate" title="Download csv of Renewal Conversion Metrics" />

Metrics Request and Response Objects [#metrics-request-and-response-objects]

<ApiSchema name="MetricRequest" />

<ApiSchema name="MetricResponse" />

<ApiSchema name="DataPoint" />

See Also [#see-also]

* [Metrics Feature Guide](/features/reporting/metrics)


## API Reference

POST /business-stats/metrics/gwp — getGWP
Tags: metrics-controller
Permissions: read
Parameters:
  offset (integer, query)
  count (integer, query)
  backfillZeroes (boolean, query)
Request body (MetricRequest):
Responses:
  200 MetricResponse — OK

POST /business-stats/metrics/issued — getIssuedPolicies
Tags: metrics-controller
Permissions: read
Parameters:
  offset (integer, query)
  count (integer, query)
  backfillZeroes (boolean, query)
Request body (MetricRequest):
Responses:
  200 MetricResponse — OK

POST /business-stats/metrics/quotes — getPricedQuotes
Tags: metrics-controller
Permissions: read
Parameters:
  offset (integer, query)
  count (integer, query)
  backfillZeroes (boolean, query)
Request body (MetricRequest):
Responses:
  200 MetricResponse — OK

POST /business-stats/metrics/conversionRate — getConversionRate
Tags: metrics-controller
Permissions: read
Parameters:
  offset (integer, query)
  count (integer, query)
  backfillZeroes (boolean, query)
Request body (MetricRequest):
Responses:
  200 MetricResponse — OK

POST /business-stats/metrics/renewedPolicies — getRenewedPolicies
Tags: metrics-controller
Permissions: read
Parameters:
  offset (integer, query)
  count (integer, query)
  backfillZeroes (boolean, query)
Request body (MetricRequest):
Responses:
  200 MetricResponse — OK

POST /business-stats/metrics/expiredPolicies — getExpiredPolicies
Tags: metrics-controller
Permissions: read
Parameters:
  offset (integer, query)
  count (integer, query)
  backfillZeroes (boolean, query)
Request body (MetricRequest):
Responses:
  200 MetricResponse — OK

POST /business-stats/metrics/renewalRate — getRenewalRate
Tags: metrics-controller
Permissions: read
Parameters:
  offset (integer, query)
  count (integer, query)
  backfillZeroes (boolean, query)
Request body (MetricRequest):
Responses:
  200 MetricResponse — OK

POST /business-stats/metrics/gwp/download — downloadGWP
Tags: metrics-controller
Permissions: read
Parameters:
  offset (integer, query)
  count (integer, query)
  backfillZeroes (boolean, query)
Request body (MetricRequest):
Responses:
  200 — OK

POST /business-stats/metrics/issued/download — downloadIssuedPolicies
Tags: metrics-controller
Permissions: read
Parameters:
  offset (integer, query)
  count (integer, query)
  backfillZeroes (boolean, query)
Request body (MetricRequest):
Responses:
  200 — OK

POST /business-stats/metrics/quotes/download — downloadPricedQuotes
Tags: metrics-controller
Permissions: read
Parameters:
  offset (integer, query)
  count (integer, query)
  backfillZeroes (boolean, query)
Request body (MetricRequest):
Responses:
  200 — OK

POST /business-stats/metrics/conversionRate/download — downloadConversionRate
Tags: metrics-controller
Permissions: read
Parameters:
  offset (integer, query)
  count (integer, query)
  backfillZeroes (boolean, query)
Request body (MetricRequest):
Responses:
  200 — OK

POST /business-stats/metrics/renewedPolicies/download — downloadRenewedPolicies
Tags: metrics-controller
Permissions: read
Parameters:
  offset (integer, query)
  count (integer, query)
  backfillZeroes (boolean, query)
Request body (MetricRequest):
Responses:
  200 — OK

POST /business-stats/metrics/expiredPolicies/download — downloadExpiredPolicies
Tags: metrics-controller
Permissions: read
Parameters:
  offset (integer, query)
  count (integer, query)
  backfillZeroes (boolean, query)
Request body (MetricRequest):
Responses:
  200 — OK

POST /business-stats/metrics/renewalRate/download — downloadRenewalRate
Tags: metrics-controller
Permissions: read
Parameters:
  offset (integer, query)
  count (integer, query)
  backfillZeroes (boolean, query)
Request body (MetricRequest):
Responses:
  200 — OK

MetricRequest
Properties:
  groupByProduct (boolean)
  groupByTenant (boolean)
  tenantLocators (uuid[])
  products (string[])
  tenantType (Enum test | production | retired | deleted)
  startTime (datetime, required)
  endTime (datetime, required)
  periodic (Enum none | day | week | month | quarter | year)
  currencies (string[])
  localStartDateAdjusted (date, required)
  localEndDateAdjusted (date, required)

MetricResponse
Properties:
  offset (integer, required)
  count (integer, required)
  startDate (date, required)
  endDate (date, required)
  periodic (Enum none | day | week | month | quarter | year, required)
  results (DataPoint[], required)

DataPoint
Properties:
  productName (string, required)
  tenantLocator (uuid, required)
  currency (string, required)
  dataPointStartDate (date, required)
  value (number, required)