Power Outage Intelligence - Search

Overview

With this API, you can search for outage intel for a site location. You can provide either latitude/longitude or address.

For detailed information on how to integrate this API endpoint into your workflow, see this article.

Endpoint Details

All requests must set the following headers:

Header Name	Header Value
Content-Type	application/json
Authorization	Bearer <your API token>

Request Method

POST

 

Request URL

https://api.gisual.com/v10/intel

Request Body

These are the full forms of the request body.

{
  "thoroughfare": "2600 Benjamin Franklin Pkwy",
  "locality": "Philadelphia",
  "administrative_area": "PA",
  "postal_code": "19130",
  "country": "US",
  "asset_name": "Node PHL013.56",
  "asset_type": "cpe",
  "asset_status": "down",
  "alarm_type": "node down",
  "alarm_subtype": "inverter failure",
  "search_id": "ticket-24602"
}

{
  "longitude": -75.166511,
  "latitude" : 39.906036,
  "asset_name": "Node PHL013.56",
  "asset_type": "node",
  "asset_status": "down",
  "alarm_type": "link down",
  "alarm_subtype": "light level",
  "search_id": "ticket-24602"
}

{
  "asset_name": "Node PHL013.56",
  "asset_type": "node",
  "asset_status": "down",
  "alarm_type": "link down",
  "alarm_subtype": "light level",
  "search_id": "ticket-24602"
}

Field Details

Field name	Purpose	Type	Allowed Value(s)	Required	Default
longitude	The longitude.	Number	-180 to 180	Yes (if using lat/long)
latitude	The latitude.	Number	-90 to 90	Yes (if using lat/long)
thoroughfare	The street address	String	Any valid street address	Yes
dependent_thoroughfare	The cross-street	String	Any	No	null
premise	The apartment or suite number, etc	String	Any	No	null
sub_premise	Any additional street address information	String	Any	No	null
dependent_locality	The neighborhood	String	Any	No	null
locality	The city, town, etc.	String	Any valid city, town, etc	Yes (if using address)
administrative_area	The state, province, etc.	String	Any valid state/province	Yes (if using address)
postal_code	The ZIP/postal code	String	Any valid ZIP/postal code	Yes (if using address)
country	The country	String	Any valid 2-letter country code	Yes (if using address)
asset_name	The name of the asset that is alarming.	String	Any	Yes (if not using lat/long or address)	null
asset_type	The type of asset that is alarming	String	Any valid asset type, which may be customized to your account	No	null
asset_status	Node status	String	"up" or "down"	No	null
alarm_type	Node alarm type	String	Any	No	null
alarm_subtype	Node alarm subtype	String	Any	No	null
search_id	User-defined search identifier	String	Any string	No	null

Response Body

This is the full form of the response body.

{
  "asset_name": "Node PHL013.56",
  "incident_name": "GIS-ARB8W",
  "incident_url": "https://app.gisual.com/map/83aa8cab-a297-4128-9e20-65ca477e1230/incident",
  "power_status": "power off",
  "etr": "2020-08-20T21:55:00-04:00",
  "location": {"coordinates": [-75.164299, 39.907011], "type": "Point"},
  "num_affected": 43,
  "utility": "PECO",
  "crew_status": "dispatched",
  "root_cause": "unknown",
  "search_id": "ticket-24602"
}

Field Details

Field name	Description	Type	Default
asset_name	The name of the asset provided with the search request, if any.	String	null
incident_name	The name of the incident Gisual's system created to track the outage	String	null
incident_url	The URL to open the incident in Gisual's Web Tool	String	null
power_status	The power status of the location "validating power" "power on" "power on - outage resolved" "power off" "asset reported online" "asset reported online" is returned when sending a request with asset_status "up".	String
etr	The outage's estimated time of resolution, given in the time zone local to the utility.	String
location	The outage's location as a GeoJSON object.	Object
num_affected	The number of electric customers affected by the outage.	Number
utility	The name of the utility the outage belongs to.	String
crew_status	The current status of the utility crew.	String
root_cause	The root cause of the utility outage.	String
search_id	The search identifier provided in the search request, if any.	String	null