Outage totals
https://api.aussieoutagetracker.com.au/v1/stats/outagesNeeds an API key on the API plan. Each call answered 2xx counts against the plan’s included calls, then is billed beyond them; refusals and our failures never are.
Totals over a window, split by network, state, cause, day or month: outages, customers affected and median duration. Cancelled work is not counted — it did not happen. Windows up to 400 days.
Query parameters
How to split the totals. day and month are cut in each outage's own state's local time.
Default network
Start of the window. Defaults to 30 days before to.
End of the window. Defaults to now.
Only these states.
Up to 20 values
Only these networks.
Up to 20 values
planned or unplanned. Omit for both.
Only these cause categories.
Up to 20 values
What each value means
The cause, in one vocabulary across every network: planned_work — maintenance, upgrades, connections, metering; weather — storms, lightning, wind, flood, heat; vegetation — trees and branches in or on the lines; animal — birds, bats, possums, wildlife; vehicle — a car, truck or high load hitting the network; third_party — vandalism, theft, dig-ins, other people's works; fire — bushfire or fire near the network; equipment — a failure of the network's own poles, wires, cables or plant; customer — a fault in the customer's installation, or work they asked for; safety — supply cut for public safety or at emergency services' request; upstream — transmission or generation, outside the distributor's network; unspecified — a fault, with no cause given yet; other — a cause the classifier does not recognise yet.
Responses
200Success
dataarray of objectShowHide 4 fields of each item
keystringThe group: a network id, a state, a cause category, a date (YYYY-MM-DD) or a month (YYYY-MM).
outagesintegercustomers_affectedintegernullableSum of customers_affected across the group's outages that carry a count. Null when none does.
median_duration_minutesintegernullableMedian duration_minutes of restored outages in the group.
windowobjectShowHide 2 fields
fromstring (date-time)ISO 8601 instant, UTC.
tostring (date-time)ISO 8601 instant, UTC.
metaobjectShowHide 1 fields
data_as_ofstring (date-time)nullableWhen the most recent successful poll of any network finished. A stale value means the feeds, not this response, are behind.
400A parameter is invalid or unknown — error.param names it.
Every error has the same envelope:
errorobjectShowHide 3 fields
codeenumunauthorizedpayment_requiredforbiddennot_foundinvalid_parameterrate_limitedinternal_errormessagestringparamstringoptionalThe query parameter at fault, for invalid_parameter.
401No API key, or one that is not valid.
Every error has the same envelope:
errorobjectShowHide 3 fields
codeenumunauthorizedpayment_requiredforbiddennot_foundinvalid_parameterrate_limitedinternal_errormessagestringparamstringoptionalThe query parameter at fault, for invalid_parameter.
402The key's account cannot be billed: no card, or billing past due.
Every error has the same envelope:
errorobjectShowHide 3 fields
codeenumunauthorizedpayment_requiredforbiddennot_foundinvalid_parameterrate_limitedinternal_errormessagestringparamstringoptionalThe query parameter at fault, for invalid_parameter.
429Over 60 requests a minute on this key. Not billed.
Every error has the same envelope:
errorobjectShowHide 3 fields
codeenumunauthorizedpayment_requiredforbiddennot_foundinvalid_parameterrate_limitedinternal_errormessagestringparamstringoptionalThe query parameter at fault, for invalid_parameter.
Errors lists every error code and what to do about it.