Dashboard

Compute one metric

Reads rollups only. Ratios with a denominator under 20 are null and breakdown groups under 10 users merge into "other", server side. Unknown metric is 404 metric_not_found; a bad parameter is 400 invalid_metric_query.

get/dashboard/apps/{app_id}/metrics/{metric_id}

Request

Base URL: https://api.whisperr.net
URL: https://api.whisperr.net/dashboard/apps/{app_id}/metrics/{metric_id}
Auth: HTTP bearer

Path parameters

app_idstring required

whisp-go runtime app id or imported onboarding source_app_id.

metric_idstring required

Query parameters

range'7d' | '30d' | '90d' | '12w'

grain'day' | 'week' | 'none'

breakdown'country' | 'platform' | 'app_version' | 'plan'

limitinteger

compare'previous_period' | 'none'

Response

The metric.

breakdown'country' | 'platform' | 'app_version' | 'plan' nullable required

breakdown_status'no_billing_source' | 'no_app_version'

Why a breakdown has no real groups; absent otherwise. The metric keeps its own status.

computed_atstring date-time required

definition_versioninteger required

formula_textstring required

grain'day' | 'week' | 'none' required

labelstring required

metricstring required

notesstring[] required

ready_onstring date nullable required

sourcestring required

status'not_installed' | 'collecting' | 'low_sample' | 'ready' required

unit'users' | 'ratio' | 'count' required

Changes

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