Skip to main content
GET
Get SOV summary

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

id
string
required

pingid, sovid, or portfolio id

Query Parameters

fields
enum<string>[]

Fields to return value distributions for in fields. Omit for none.

  • country - country
  • state - state
  • county - county
  • const__bldg_year_built - const__bldg_year_built
  • wind_tier - wind_tier
  • fema_flood_zone - fema_flood_zone
  • slosh_zone - slosh_zone
  • ping_geo__match_level - ping_geo__match_level
Available options:
country,
state,
county,
const__bldg_year_built,
wind_tier,
fema_flood_zone,
slosh_zone,
ping_geo__match_level
filters
object

Location filters. Send each field as its own query parameter: field=value for an exact match, field[op]=value for an operator. state=TX&state=FL&const__bldg_year_built[gte]=1990 selects locations in TX or FL built in 1990 or later.

  • Different fields: a location must match all of them.
  • Repeating a field, or [bins] with several bins: matches any of the values.
  • Several operators on one field: all must hold, forming a range.
  • N/A as an exact value: matches locations missing the field.
  • A field takes an exact value, [bins] or range operators, not a mix.

See SOV Data Analysis for every rule and examples. Location filters. Each key is a field: give a value for an exact match, or an object of operators.

layer_attach
integer
default:0

Layer attachment point. With layer_limit, defines the layer whose per-location exposure is reported as limits__total_limit_in_layer. Defaults to 0.

layer_limit
integer

Layer limit. With layer_attach, defines the layer whose per-location exposure is reported as limits__total_limit_in_layer. Omit for a layer with no upper limit.

Response

Summary of the matching locations.

fields
object
required

Value distribution of the matching locations for each requested field, keyed by field name.

filename
string | null
required

Filename of the submitted SOV.

insured
object
required

Insured details.

kind
enum<string>
required

Whether sovid is a policy or portfolio.

  • policy - policy
  • portfolio - portfolio
Available options:
policy,
portfolio
pct_complete
integer
required

Build progress, 0-100.

risk_summary
string | null
required

Narrative summary of the insured's risk.

sovid
string
required

SOV id, or portfolio id when kind is portfolio.

status
enum<string>
required

Analytics build status. Always READY in a 200 response.

  • NOT_INITIALIZED - NOT_INITIALIZED
  • INITIALIZING - INITIALIZING
  • READY - READY
  • FAILED - FAILED
Available options:
NOT_INITIALIZED,
INITIALIZING,
READY,
FAILED
totals
object
required

Totals over the matching locations.