Sign in

Get v0 city by city name usage

Changed on
get/v0/city/{cityName}/usage

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

cityNamestring required

City name.

Query parameters

aggregate_onlyboolean

Omit the per-session breakdown and return city-level totals only.

Response

OK

availableboolean required

True when this city is configured to record local usage estimates.

observed_fromstring

RFC3339 timestamp of the oldest fact included in this bounded read.

partialboolean

True when the bounded reader skipped history or malformed records.

partial_reasonsstring[] nullable

Path-sanitized reasons the aggregate may be incomplete.

recent_window_secsinteger required

Length of the recent window in seconds.

recordingboolean required

True when new facts are currently being written to the local estimate log.

source'local_estimate' | 'unavailable' required

Source of this usage reading.

updated_atstring required

RFC3339 time at which the aggregate was built.

Changes