Skip to main content
GET
What one report figure counts

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Path Parameters

metric
string
required

The metric's key, from GET /v1/platform/reports/definitions (e.g. collected, churnRate).

Query Parameters

locale
enum<string>
default:en

The language of sentence.

Available options:
en,
es,
fr,
de,
bg,
cs

Response

The definition

key
string
required
Example:

"collected"

title
string
required

The metric's English name

Example:

"Collected"

family
enum<string>
required
Available options:
money,
time,
places,
customers,
email
sentence
string
required

What the metric counts.

locale
enum<string>
required

The language sentence is in.

Available options:
en,
es,
fr,
de,
bg,
cs
reports
string[]
required

The admin report pages whose cards show it.

rule
object | null
required

The written rule the sentence states, null where none is written yet.