SHshorebird
metrics

Cumulative patch-adoption curves for a release.

Returns, for a single release, the cumulative adoption of each patch: the distinct devices running patch >= N (an HLL count over hourly_user_sketches) over the patch's target — the distinct devices on the release whose platform the patch was built for. Adoption percentages are computed server-side and clamped to [0.0, 1.0]; clients should render them rather than recompute.

Values are cumulative ("patch >= N"), so they are monotonic non-increasing in patch_number.

The release is the release_version query parameter, or — when omitted — the app's latest release by creation date (is_latest flags that case). The window defaults to the last 28 days and is capped at 450 days (the effective window is echoed in range). With granularity omitted, each patch carries a single full-window value (period: null); set it for a curve at that resolution.

get/apps/{appId}/metrics/patch-adoption

Request

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

Query parameters

release_versionstring

The release to report on. Omitted ⇒ the app's latest release by creation date.

startstring date-time

Window start (UTC, inclusive). Defaults to end minus 28 days; clamped so the window never exceeds 450 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. Omitted ⇒ a single full-window value per patch (period: null); 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).

Response

The patch-adoption data for one release.

release_versionstring required

The release version this response is for.

is_latestboolean required

True when the release was resolved via the "latest release by creation date" default (no release_version was supplied).

granularitystring nullable required

The bucket resolution (hour, day, or week), or null when each patch carries a single full-window value.

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 query and may lag by up to ~1 hour.

Changes

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