Domino AI API
Domino AI API
v1.31.2 OAS 3.1
default
POST/v1/location/business-interruption/return-period
Business Interruption Risk Scores By Return Period
Business Interruption Risk Scores By Return Period
returns business interruption risk scores for location entries based on the return period
Parameters
| Name | Description |
|---|---|
| client-id * string (header) |
|
| transaction-id string (header) |
Request body
application/json
- Example Value
- Schema
{
"interruption_type": "integrated",
"latitude": 33.814437,
"longitude": -118.051187,
"max_distance_m": 100,
"climate_change": "ccbaseline",
"return_period_yrs": 50,
"peril": "flood"
}
Responses
| Code | Description | Links |
|---|---|---|
| 200 | Successful Response Media type application/json Controls Accept header.- Example Value - Schema json<br>{<br> "id": "string",<br> "downtime_avg_days": 1.5,<br> "downtime_stdev_days": 1.5,<br> "score": "very_low"<br>}<br> |
No links |
| 204 | No data available for given latitude/longitude - Example Value json<br>"string"<br> |
No links |
| 422 | Validation Error Media type application/json - Example Value - Schema json<br>{<br> "detail": [<br> {<br> "loc": [<br> "string",<br> 0<br> ],<br> "msg": "string",<br> "type": "string"<br> }<br> ]<br>}<br> |
No links |
POST/v1/location/business-interruption/average-annual
Business Interruption Risk Scores By Average Annual Downtime
Business Interruption Risk Scores By Average Annual
returns business interruption risk scores for location entries based on the average annual downtime
Parameters
| Name | Description |
|---|---|
| client-id * string (header) |
|
| transaction-id string (header) |
Request body
application/json
- Example Value
- Schema
{
"interruption_type": "integrated",
"latitude": 33.814437,
"longitude": -118.051187,
"max_distance_m": 100,
"climate_change": "ccbaseline",
"peril": "flood"
}
Responses
POST/v1/location/business-interruption/planning-horizon
BI Risk Score By Planning Horizon
BI Risk by Planning Horizon
returns bi risk score for location entries based on planning horizon years
Parameters
| Name | Description |
|---|---|
| client-id * string (header) |
|
| transaction-id string (header) |
Request body
application/json
- Example Value
- Schema
{
"interruption_type": "integrated",
"latitude": 33.814437,
"longitude": -118.051187,
"max_distance_m": 100,
"climate_change": "ccbaseline",
"planning_horizon_yrs": 1,
"peril": "flood"
}
Responses
POST/v1/location/property-damage/return-period
Property Damage Ratio By Return Period
Property Damage By Return Period
returns property damage for location entries based on the return period
Parameters
| Name | Description |
|---|---|
| client-id * string (header) |
|
| transaction-id string (header) |
Request body
application/json
- Example Value
- Schema
{
"latitude": 33.814437,
"longitude": -118.051187,
"max_distance_m": 100,
"peril": "flood",
"climate_change": "ccbaseline",
"return_period_yrs": 50
}
Responses
| Code | Description | Links |
|---|---|---|
| 200 | Successful Response Media type application/json Controls Accept header.- Example Value - Schema json<br>{<br> "id": "string",<br> "damage_ratio_avg": 0.1,<br> "damage_ratio_stdev": 0.05<br>}<br> |
No links |
| 204 | No data available for given latitude/longitude - Example Value json<br>"string"<br> |
No links |
| 422 | Validation Error Media type application/json - Example Value - Schema json<br>{<br> "detail": [<br> {<br> "loc": [<br> "string",<br> 0<br> ],<br> "msg": "string",<br> "type": "string"<br> }<br> ]<br>}<br> |
No links |
POST/v1/location/property-damage/average-annual
Property Damage Ratio By Average Annual Downtime
Property Damage By Average Annual Downtime
returns property damage for location entries based on the average annual downtime
Parameters
| Name | Description |
|---|---|
| client-id * string (header) |
|
| transaction-id string (header) |
Request body
application/json
- Example Value
- Schema
{
"latitude": 33.814437,
"longitude": -118.051187,
"max_distance_m": 100,
"peril": "flood",
"climate_change": "ccbaseline"
}