v1

latestOpenAPI 3.0.32026-07-26120117318.1 KB
Analytics

Get analytics chart metadata

Returns the chart's display metadata: available filter attributes and their concrete values (pre-scoped to the project), available segmentation dimensions, supported time units, and chart types. Use this to build a UI / discover the filter[<attribute>][] and segmentation values for GET /v4/analytics/charts/{chart_code}.

get/analytics/charts/{chart_code}/meta

Path parameters

chart_code'proceeds' | 'active-subscriptions' | 'paid-subscriptions-movement' | 'users-overview' | 'free-trials' | 'active-trials' | 'trials-movement' | 'user-to-trial' | 'trial-to-paid' | 'user-to-paid' | 'sales' | 'refunds' | 'refund-rate' | 'arppu' | 'arpu' | 'trial-cancellation' | 'subscription-cancellation' | 'subscriptions-overview' | 'new-subscriptions' | 'mrr' | 'arr' | 'mrr-movement' | 'arr-movement' | 'user-to-trial-conversion' | 'subscription-cancellation-rate' required

Chart code. Must be a publicly exposed chart (see GET /v4/analytics/charts/{chart_code}).

Query parameters

frominteger

Time range start (Unix timestamp, seconds). Used to scope filter value enumeration.

tointeger

Time range end (Unix timestamp, seconds). Used to scope filter value enumeration.

environment0 | 1

Environment: 0 = sandbox, 1 = production.

Response

Chart metadata.

object'analytics_chart_meta' required
urlstring required
codestring required
titlestring required
descriptionstring
docUrlstring

Link to the narrative documentation for this chart.

isAvailableboolean required

False when the chart is blocked by the project's plan or feature flag.

availabilityMessagestring

Human-readable reason the chart is unavailable. Empty when isAvailable=true.

type_defaultstring

Recommended visual type (e.g. column).

typesstring[]
units_availablestring[] required