Skip to main content
GET
Get SOV layer analysis

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

id
string
required

pingid, sovid, or portfolio id

Query Parameters

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.

layers
string[]

Custom tower, one layer per value, as <limit>xs<attach> in whole currency units: 5000000xs0 is a primary $5M layer and xs200000000 is everything above $200M. Up to 20 layers. Cannot be combined with tower.

Required array length: 1 - 20 elements
Pattern: ^(\d+)?xs(\d+)$
tower
enum<string>

Preset layer tower. standard is Primary $5M, $5M xs $5M, $15M xs $10M, $25M xs $25M, $50M xs $50M, $100M xs $100M and everything above $200M. Defaults to standard when layers is omitted.

  • standard - standard
Available options:
standard

Response

Layer analysis for the matching locations.

basis
enum<string>
required

per_location: each layer applies to every location's limits__total_limit separately, not to the aggregate.

  • per_location - per_location
Available options:
per_location
rows
object[]
required

One row per layer, in tower order.

tower
enum<string>
required

standard for the preset tower, custom when layers was supplied.

  • standard - standard
  • custom - custom
Available options:
standard,
custom