Socotra
API ReferenceReporting API

Metrics API

ActionEndpoint
Fetch GWP metricsPOST/business-stats/metrics/gwp
Fetch Issued Policy MetricsPOST/business-stats/metrics/issued
Fetch Priced Quote MetricsPOST/business-stats/metrics/quotes
Fetch New Business Conversion MetricsPOST/business-stats/metrics/conversionRate
Fetch Issued Renewal MetricsPOST/business-stats/metrics/renewedPolicies
Fetch Expired Policy MetricsPOST/business-stats/metrics/expiredPolicies
Fetch Renewal Conversion MetricsPOST/business-stats/metrics/renewalRate
Download csv of GWP metricsPOST/business-stats/metrics/gwp/download
Download csv of Issued Policy MetricsPOST/business-stats/metrics/issued/download
Download csv of Priced Quote MetricsPOST/business-stats/metrics/quotes/download
Download csv of New Business Conversion MetricsPOST/business-stats/metrics/conversionRate/download
Download csv of Issued Renewal MetricsPOST/business-stats/metrics/renewedPolicies/download
Download csv of Expired Policy MetricsPOST/business-stats/metrics/expiredPolicies/download
Download csv of Renewal Conversion MetricsPOST/business-stats/metrics/renewalRate/download

Metrics Data Response Endpoints

Fetch GWP metrics

Fetch GWP metricsgetGWP
POST/business-stats/metrics/gwp

Parameters

NameInTypeRequiredDescription
offsetqueryinteger?No
countqueryinteger?No
backfillZeroesqueryboolean?No
Security Group:metrics
Permission:
read

Fetch Issued Policy Metrics

Fetch Issued Policy MetricsgetIssuedPolicies
POST/business-stats/metrics/issued

Parameters

NameInTypeRequiredDescription
offsetqueryinteger?No
countqueryinteger?No
backfillZeroesqueryboolean?No
Security Group:metrics
Permission:
read

Fetch Priced Quote Metrics

Fetch Priced Quote MetricsgetPricedQuotes
POST/business-stats/metrics/quotes

Parameters

NameInTypeRequiredDescription
offsetqueryinteger?No
countqueryinteger?No
backfillZeroesqueryboolean?No
Security Group:metrics
Permission:
read

Fetch New Business Conversion Metrics

Fetch New Business Conversion MetricsgetConversionRate
POST/business-stats/metrics/conversionRate

Parameters

NameInTypeRequiredDescription
offsetqueryinteger?No
countqueryinteger?No
backfillZeroesqueryboolean?No
Security Group:metrics
Permission:
read

Fetch Issued Renewal Metrics

Fetch Issued Renewal MetricsgetRenewedPolicies
POST/business-stats/metrics/renewedPolicies

Parameters

NameInTypeRequiredDescription
offsetqueryinteger?No
countqueryinteger?No
backfillZeroesqueryboolean?No
Security Group:metrics
Permission:
read

Fetch Expired Policy Metrics

Fetch Expired Policy MetricsgetExpiredPolicies
POST/business-stats/metrics/expiredPolicies

Parameters

NameInTypeRequiredDescription
offsetqueryinteger?No
countqueryinteger?No
backfillZeroesqueryboolean?No
Security Group:metrics
Permission:
read

Fetch Renewal Conversion Metrics

Fetch Renewal Conversion MetricsgetRenewalRate
POST/business-stats/metrics/renewalRate

Parameters

NameInTypeRequiredDescription
offsetqueryinteger?No
countqueryinteger?No
backfillZeroesqueryboolean?No
Security Group:metrics
Permission:
read

Metrics CSV Download Endpoints

Download csv of GWP metrics

Download csv of GWP metricsdownloadGWP
POST/business-stats/metrics/gwp/download

Parameters

NameInTypeRequiredDescription
offsetqueryinteger?No
countqueryinteger?No
backfillZeroesqueryboolean?No
Response:StreamingResponseBody<string>
Security Group:metrics
Permission:
read

Download csv of Issued Policy Metrics

Download csv of Issued Policy MetricsdownloadIssuedPolicies
POST/business-stats/metrics/issued/download

Parameters

NameInTypeRequiredDescription
offsetqueryinteger?No
countqueryinteger?No
backfillZeroesqueryboolean?No
Response:StreamingResponseBody<string>
Security Group:metrics
Permission:
read

Download csv of Priced Quote Metrics

Download csv of Priced Quote MetricsdownloadPricedQuotes
POST/business-stats/metrics/quotes/download

Parameters

NameInTypeRequiredDescription
offsetqueryinteger?No
countqueryinteger?No
backfillZeroesqueryboolean?No
Response:StreamingResponseBody<string>
Security Group:metrics
Permission:
read

Download csv of New Business Conversion Metrics

Download csv of New Business Conversion MetricsdownloadConversionRate
POST/business-stats/metrics/conversionRate/download

Parameters

NameInTypeRequiredDescription
offsetqueryinteger?No
countqueryinteger?No
backfillZeroesqueryboolean?No
Response:StreamingResponseBody<string>
Security Group:metrics
Permission:
read

Download csv of Issued Renewal Metrics

Download csv of Issued Renewal MetricsdownloadRenewedPolicies
POST/business-stats/metrics/renewedPolicies/download

Parameters

NameInTypeRequiredDescription
offsetqueryinteger?No
countqueryinteger?No
backfillZeroesqueryboolean?No
Response:StreamingResponseBody<string>
Security Group:metrics
Permission:
read

Download csv of Expired Policy Metrics

Download csv of Expired Policy MetricsdownloadExpiredPolicies
POST/business-stats/metrics/expiredPolicies/download

Parameters

NameInTypeRequiredDescription
offsetqueryinteger?No
countqueryinteger?No
backfillZeroesqueryboolean?No
Response:StreamingResponseBody<string>
Security Group:metrics
Permission:
read

Download csv of Renewal Conversion Metrics

Download csv of Renewal Conversion MetricsdownloadRenewalRate
POST/business-stats/metrics/renewalRate/download

Parameters

NameInTypeRequiredDescription
offsetqueryinteger?No
countqueryinteger?No
backfillZeroesqueryboolean?No
Response:StreamingResponseBody<string>
Security Group:metrics
Permission:
read

Metrics Request and Response Objects

MetricRequest

Required properties

PropertyTypeDescription
startTimedatetime
endTimedatetime
localEndDateAdjusteddate
localStartDateAdjusteddate

Optional properties

PropertyTypeDescription
groupByProductboolean?
groupByTenantboolean?
periodicEnum? none | day | week | month | quarter | year
tenantTypeEnum? test | production | retired | deleted
currenciesstring[]?
productsstring[]?
tenantLocatorsuuid[]?
MetricResponse

Required properties

PropertyTypeDescription
countinteger
endDatedate
offsetinteger
periodicEnum none | day | week | month | quarter | year
startDatedate
resultsDataPoint[]
DataPoint

Required properties

PropertyTypeDescription
tenantLocatoruuid
productNamestring
currencystring
dataPointStartDatedate
valuenumber

See Also

On this page