Skip to main content
GET
List SOV locations

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.

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.

limit
integer
default:100

Maximum number of locations to return, up to 1000. Defaults to 100.

Required range: 1 <= x <= 1000
offset
integer
default:0

Number of locations to skip before the first one returned. Defaults to 0.

Required range: x >= 0
sort
enum<string>
default:-limits__total_limit

Sort order. A leading - sorts descending. Portfolios sort by member SOV first. Defaults to -limits__total_limit.

  • -limits__total_limit - -limits__total_limit
  • limits__total_limit - limits__total_limit
  • building_counter - building_counter
  • -building_counter - -building_counter
Available options:
-limits__total_limit,
limits__total_limit,
building_counter,
-building_counter

Response

One page of matching locations.

count
integer
required

Total number of matching locations.

next
string<uri> | null
required

URL of the next page. Null on the last page.

previous
string<uri> | null
required

URL of the previous page. Null on the first page.

results
object[]
required

Locations on this page.