Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request to create a new saved metric

template
enum<string>
required

Metric template name

Available options:
GROSS_VOLUME,
TRANSACTION_COUNT,
NEW_USERS
name
string
required

User-defined metric name

Required string length: 1 - 100
params
object
required

Metric parameters. Structure varies by template, but common fields include:

  • Date range filters
  • Calculation interval
  • Breakdown dimensions
  • Template-specific filters

Additional properties may be present based on the metric template. Each template may define template-specific parameters.

description
string | null

Optional description for the metric

Maximum string length: 500

Response

Metric created successfully

Single metric response

status
enum<string>
Available options:
success
data
object

A saved metric definition

metadata
object