SHshorebird
metrics

Activity heatmap — average active devices per UTC weekday-hour.

Returns the app's average distinct active-device count for each (UTC day-of-week, UTC hour-of-day) cell over a server-side lookback window — a 7×24 activity profile for an insights heatmap. Sourced from the same hourly_user_sketches data as the active-hours advisor, just sliced by weekday as well as hour.

get/apps/{appId}/metrics/activity-heatmap

Request

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

Response

The 7×24 UTC activity heatmap.

busiest_day_of_week_utcinteger nullable required

UTC day-of-week (1–7) of the cell with the highest average active devices, for peak-relative coloring and labeling. Null when there is no data.

busiest_hour_utcinteger nullable required

UTC hour (0–23) of the busiest cell. Null when there is no data.

lookback_daysinteger required

Number of days of history the heatmap 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.