An outage's history

GEThttps://api.aussieoutagetracker.com.au/v1/outages/{id}/history

Needs 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.

Every change recorded for one outage, oldest first: each status, each moved restoration estimate, each change in customers off or in the localities affected. No network publishes this; it exists because Aussie Outage Tracker was watching.

Path parameters

integerrequired

The outage id.

Responses

200Success
dataarray of object
ShowHide 9 fields of each item
observed_atstring (date-time)

When this change was recorded.

statusenum

Lifecycle. active: supply is affected now. scheduled: planned work not yet started. restored: supply is back. cancelled: called off without happening — never summed with restored. unknown: the network gave no status signal at all (vanishingly rare).

scheduledactiverestoredcancelledunknown
status_detailstringnullable
customers_offintegernullable
estimated_restoration_atstring (date-time)nullable

ISO 8601 instant, UTC.

starts_atstring (date-time)nullable

ISO 8601 instant, UTC.

restored_atstring (date-time)nullable

ISO 8601 instant, UTC.

localitiesarray of objectnullable

The locality list as at this observation, where it changed.

ShowHide 3 fields of each item
namestring

Locality name, title-cased where the network writes capitals.

postcodestringnullable

Four-digit postcode, or null where the network gives none.

customersintegernullable

Customers affected in this locality, where the network breaks it down.

footprint_changedboolean

True when the outage's shape changed at this observation.

metaobject
ShowHide 1 fields
data_as_ofstring (date-time)nullable

When 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:

errorobject
ShowHide 3 fields
codeenum
unauthorizedpayment_requiredforbiddennot_foundinvalid_parameterrate_limitedinternal_error
messagestring
paramstringoptional

The query parameter at fault, for invalid_parameter.

401No API key, or one that is not valid.

Every error has the same envelope:

errorobject
ShowHide 3 fields
codeenum
unauthorizedpayment_requiredforbiddennot_foundinvalid_parameterrate_limitedinternal_error
messagestring
paramstringoptional

The 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:

errorobject
ShowHide 3 fields
codeenum
unauthorizedpayment_requiredforbiddennot_foundinvalid_parameterrate_limitedinternal_error
messagestring
paramstringoptional

The query parameter at fault, for invalid_parameter.

404No such resource among published data.

Every error has the same envelope:

errorobject
ShowHide 3 fields
codeenum
unauthorizedpayment_requiredforbiddennot_foundinvalid_parameterrate_limitedinternal_error
messagestring
paramstringoptional

The query parameter at fault, for invalid_parameter.

429Over 60 requests a minute on this key. Not billed.

Every error has the same envelope:

errorobject
ShowHide 3 fields
codeenum
unauthorizedpayment_requiredforbiddennot_foundinvalid_parameterrate_limitedinternal_error
messagestring
paramstringoptional

The query parameter at fault, for invalid_parameter.

Errors lists every error code and what to do about it.