Skip to main content
GET
Get analytics chart metadata

Authorizations

Authorization
string
header
required

Bearer authentication using the project Secret Key (prefixed with sk_, or test_sk_ for sandbox). All v4 public endpoints require the Secret Key — see Authentication. Never expose the Secret Key in client-side code.

Path Parameters

chart_code
enum<string>
required

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

Available options:
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
Maximum string length: 64

Query Parameters

from
integer<int64>

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

to
integer<int64>

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

environment
enum<integer>
default:1

Environment: 0 = sandbox, 1 = production.

Available options:
0,
1

Response

Chart metadata.

object
enum<string>
required
Available options:
analytics_chart_meta
url
string
required
code
string
required
title
string
required
isAvailable
boolean
required

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

units_available
enum<string>[]
required
Available options:
hour,
day,
week,
month
segmentations
object[]
required
filter_conditions
object[]
required
description
string
docUrl
string

Link to the narrative documentation for this chart.

availabilityMessage
string

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

type_default
string

Recommended visual type (e.g. column).

types
enum<string>[]
Available options:
line,
column,
area,
bar,
pie