This is a preview version of the API intended for early testing and integration. Preview versions are not stable and may include breaking changes before general availability.

SE · Intelligence API · 2026-04-01

CoverageHeldPolicy

One policy's covers. Every field is nullable: null means the metrics service did not report it, a null list is not an empty one, and a null held is unknown, not false.

collectionIdstring

coverageMatchedboolean

coversArray<CoverageHeldCover>

peerGroupstring

peerPolicyCountinteger[int32]

peerStatusstring

compared when the policy has peer shares, otherwise why not: not_scored (outside SE), group_unknown (no policy group), group_not_compared (a group without peer data), no_segment (no age), no_snapshot (no peer snapshot yet) or group_below_floor (too few peers). The list can grow between releases; parse it leniently.

policyGroupstring

The group the policy's covers are read in: car_full, car_half, car_traffic, car_laid_up, condo, villa_contents or villa_house_only. Null when the covers that decide the group are unknown. The list can grow between releases; parse it leniently.

productIdstring

scoredboolean

subTypestring

Example

{
  "collectionId": "e2a8f4c6-1b9d-4f3a-8e7c-5a0b2d6f9e13",
  "coverageMatched": true,
  "covers": [
    {
      "group": "BASIC_COVERAGE",
      "kind": "package",
      "parameterName": "crisis",
      "peerShare": 0.92
    },
    {
      "group": "BASIC_COVERAGE",
      "held": false,
      "kind": "package",
      "parameterName": "wrongFuel",
      "peerShare": 0.83
    },
    {
      "group": "ADD_ON",
      "held": true,
      "kind": "add_on",
      "parameterName": "assistance",
      "peerShare": 0.46
    },
    {
      "group": "ADD_ON",
      "held": false,
      "kind": "add_on",
      "parameterName": "rental",
      "peerShare": 0.46
    },
    {
      "group": "DEDUCTIBLE_TERMS",
      "held": true,
      "kind": "add_on",
      "parameterName": "deductibleDiscountAnimalCollision",
      "peerShare": 0.62
    }
  ],
  "peerGroup": "SE_30_44|car_full",
  "peerPolicyCount": 25592,
  "peerStatus": "compared",
  "policyGroup": "car_full",
  "productId": "6a1f3c9e-2b7d-4e05-9c84-1d2e3f4a5b6c",
  "scored": true,
  "subType": "carInsurance"
}

{  "collectionId": "e2a8f4c6-1b9d-4f3a-8e7c-5a0b2d6f9e13",  "coverageMatched": true,  "covers": [    {      "group": "BASIC_COVERAGE",      "kind": "package",      "parameterName": "crisis",      "peerShare": 0.92    },    {      "group": "BASIC_COVERAGE",      "held": false,      "kind": "package",      "parameterName": "wrongFuel",      "peerShare": 0.83    },    {      "group": "ADD_ON",      "held": true,      "kind": "add_on",      "parameterName": "assistance",      "peerShare": 0.46    },    {      "group": "ADD_ON",      "held": false,      "kind": "add_on",      "parameterName": "rental",      "peerShare": 0.46    },    {      "group": "DEDUCTIBLE_TERMS",      "held": true,      "kind": "add_on",      "parameterName": "deductibleDiscountAnimalCollision",      "peerShare": 0.62    }  ],  "peerGroup": "SE_30_44|car_full",  "peerPolicyCount": 25592,  "peerStatus": "compared",  "policyGroup": "car_full",  "productId": "6a1f3c9e-2b7d-4e05-9c84-1d2e3f4a5b6c",  "scored": true,  "subType": "carInsurance"}