SHshorebird
metrics

Patch installs for one release over a window.

Returns patch installs for a single release over a time window — summed over hourly counts — as a current/previous envelope, identical in shape to the app-scoped variant. With granularity set, each window carries a time_series; with group_by=patch set, current carries a breakdown with one entry per patch of the release (each with its own time_series when a granularity is also requested). previous never carries a breakdown. The window defaults to the last 28 days and starts no earlier than 2025-04-01, when counting began, so a start at or before it reads every install recorded; the effective range is echoed in each window's range.

get/apps/{appId}/releases/{releaseId}/metrics/patch-installs

Request

  • Base URL
    https://api.shorebird.dev/api/v1
  • Auth
    • HTTP bearer
    • or HTTP bearer

Query parameters

startstring date-time

Window start (UTC, inclusive). Defaults to end minus 28 days.

endstring date-time

Window end (UTC, exclusive). Defaults to now. A window "ending now" must omit this parameter rather than send a client-computed timestamp — clock skew would silently turn the request into a historical query.

granularity'hour' | 'day' | 'week'

The bucket resolution of a metrics time series.

Bucket resolution for the time series. Omitted ⇒ no time_series (one summed value per window); set ⇒ one point per bucket at this resolution. When set, the window length is rounded down to a whole multiple of the bucket size (echoed in range), which guarantees current and previous have equal bucket counts.

group_by'patch'

Dimension to break the total down by. Omitted ⇒ no breakdown. Release scope breaks down by patch.

Response

The patch-installs metric for the release.

as_ofstring date-time required

Server's UTC timestamp at the moment the response was constructed. Not a freshness indicator for the underlying data, which is refreshed by an hourly scheduled job and may lag by up to ~1 hour.

granularitystring nullable required

The time-series bucket resolution (hour, day, or week), or null when no time series was requested. Applies to both windows.

Changes

No recorded changes to this operation across all 1 revision of this API.