Skip to main content
GET
Get SOV exposure report

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

id
string
required

pingid, sovid, or portfolio id

Query Parameters

breakdown_limit
integer
default:5

Maximum rows in each country, state and county breakdown. Remaining values are combined into one All Others row. Defaults to 5.

Required range: 1 <= x <= 100
exposure_analysis_limits__total_limit__gte
integer
default:0

Minimum limits__total_limit of the locations counted by the exposure-analysis section rows. Other sections and totals include all matching locations. Defaults to 0.

Required range: x >= 0
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

Exposure report for the matching locations.

breakdowns
object[]
required

limits__total_limit by country, state and county, largest first, with keys country, state and county.

kind
enum<string>
required

Whether sovid is a policy or portfolio.

  • policy - policy
  • portfolio - portfolio
Available options:
policy,
portfolio
layers
object
required

Layer analysis for the standard tower.

params
object
required

Echo of the parameters the report was built with.

sections
object[]
required

Report sections, in display order.

sovid
string
required

SOV id, or portfolio id when kind is portfolio.

totals
object
required

Totals over the matching locations.