SHshorebird
metrics

Best time to release — lowest-activity UTC window.

Returns the app's average active-device count per UTC hour-of-day over a server-side lookback window, plus the recommended lowest-activity consecutive window (the best time to push a patch with minimal user disruption) and the busiest hour for contrast. Recommendation fields are null when there is insufficient history (fewer than 7 days).

get/apps/{appId}/metrics/active-hours

Request

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

Response

The active-hours profile and release-time recommendation.

recommended_window_start_utcinteger nullable required

Start hour (UTC, 0–23) of the lowest-activity consecutive window — the recommended time to release. The window wraps past midnight. Null when there is insufficient data (fewer than 7 days).

recommended_window_length_hoursinteger required

Length of the recommended window in hours. Fixed at 2 in v1.

busiest_hour_utcinteger nullable required

UTC hour (0–23) with the highest average active devices, for contrast in the recommendation copy. Null when insufficient data.

lookback_daysinteger required

Number of days of history the profile is computed over.

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.