List all Metrics

Reference for the GET /console/v1/metrics/list endpoint of the Statsig API.

gethttps://statsigapi.net/console/v1/metrics/list

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Query parameters

showHiddenMetricsstring

Should hidden metrics be returned: Allowed values are "true" or "false".

Allowed values:truefalse
tagsoneOf

Filter metrics based on a given tagID, found on /tags endpoint. Can be a single string or an array of strings.

Constraints:stringstring[]
filtersstring

Additional filters for metrics. Can be a string or an object with tags filter.

limitinteger

Results per page

Example:10
Constraints:stringnumber
pageinteger

Page number

Example:1
Constraints:stringnumber

Response

application/json
200· List all metrics in the project response
messagestringrequired

A simple string explaining the result of the operation.

dataobject[]required
Show child attributes
namestringrequired

The name of the metric, serving as its primary identifier.

Example:metricName
typestringrequired

The type of the metric, defining its aggregation method and characteristics.

Allowed values:ratiosumcompositemeanevent_count_customevent_userevent_user_windowfunnelundefinedsetup_incompletecomposite_sumimport_windowuser_warehousehybrid_warehousecount_distinctads_segment_active_usersads_segment_exposed_user_dayspercentilelatest_value
Example:sum
isVerifiedboolean

Marks the metric as verified, indicating trustworthiness within the organization.

Example:false
isReadOnlyboolean

Set to true to make the metric definition editable only through the Console API.

Example:false
unitTypesstring[]

Array of unit types associated with the metric, such as stableID or userID.

Example:["stableID","userID"]
metricEventsobject[]

An array of event definitions used to compute the metric. For ratio metrics, each event must use count or count_distinct aggregation.

Example:[{"name":"event1","type":"value"}]
namestringrequired

The name of the metric event.

typestring

Aggregation type for the metric event. Allowed values: count, count_distinct, value, metadata. For ratio metrics, only count and count_distinct are valid. Do not confuse with criteria[].type, which is a filter condition type.

Allowed values:countcount_distinctvaluemetadata
Constraints:nullable
metadataKeystring

The key for associated metadata, if applicable.

criteriaobject[]

Filtering criteria for the metric event, including conditions and values to refine the event data.

typestringrequired

Type of event criterion for filtering metrics. Options include value, metadata, user, and user_custom; in Warehouse Native, this should always be metadata.

Allowed values:valuemetadatauseruser_custom
columnstring

Optional column specifying which data attribute to filter on.

conditionstringrequired

sql_filter, start_withs, ends_with, after_exposure, and before_exposure are only applicable in Warehouse Native

Allowed values:innot_in=><>=<=is_nullnon_nullcontainsnot_containssql_filterstarts_withends_withafter_exposurebefore_exposureis_trueis_false
valuesstring[]

Optional array of values for the criterion to match against.

nullVacuousOverrideboolean

If true, overrides null values in criterion evaluation.

metricComponentMetricsobject[]

List of input metrics used to calculate the new metric for composite types.

Example:[]
namestringrequired
typestringrequired
descriptionstring

An optional description providing additional context about the metric.

Example:the description of this metric
directionalitystringrequired

Specifies the desired directionality for the metric, indicating whether an increase or decrease is favorable.

Allowed values:increasedecrease
Example:increase
tagsstring[]

Optional tags for categorizing the metric and improving searchability.

Example:["tag1","tag2"]
isPermanentboolean

Indicates whether the metric is permanent and should not be deleted.

Example:false
rollupTimeWindowstring

Time window for the metric rollup. Specify "custom" for a customized time window.

Example:custom
customRollUpStartnumber

Custom time window start date in days since exposure.

Example:1
Constraints:format: double
customRollUpEndnumber

Custom time window end date in days since exposure.

Example:1
Constraints:format: double
percentilenumber

Percentile value for percentile metrics.

Example:0.95
Constraints:format: doublemin: 0.001max: 0.999
funnelEventListobject[]

List of events used to create funnel metrics.

namestringrequired

The name of the funnel event used in the metric.

Example:event1
typestringrequired

The type of funnel event, specifying how the event is tracked.

Allowed values:event_dauevent_userevent_countevent_count_custom
Example:event_dau
funnelCountDistinctstring

Specifies whether to count events or distinct users for the funnel metric.

Allowed values:eventsusers
warehouseNativeobject

Defines warehouse native metrics for advanced configurations.

aggregationstring

Allowed: count┃sum┃mean┃daily_participation┃ratio┃funnel┃count_distinct┃percentile

Allowed values:countsummeandaily_participationratiofunnelcount_distinctpercentilefirst_valuelatest_valueretentionmaxmincomposite
metricSourceNamestring

Deprecated: use metricSources instead. If provided, this will overwrite all metric sources. For Count, Sum, Mean, User Count aggregation types: the name of metric source

criteriaobject[]

Deprecated: use metricSources instead. If provided with metricSourceName, this will overwrite all metric sources. Filtering criteria for the metric source

typestringrequired

Type of event criterion for filtering metrics. Options include value, metadata, user, and user_custom; in Warehouse Native, this should always be metadata.

Allowed values:valuemetadatauseruser_custom
columnstring

Optional column specifying which data attribute to filter on.

conditionstringrequired

sql_filter, start_withs, ends_with, after_exposure, and before_exposure are only applicable in Warehouse Native

Allowed values:innot_in=><>=<=is_nullnon_nullcontainsnot_containssql_filterstarts_withends_withafter_exposurebefore_exposureis_trueis_false
valuesstring[]

Optional array of values for the criterion to match against.

nullVacuousOverrideboolean

If true, overrides null values in criterion evaluation.

metricSourcesobject[]

List of metric sources for this metric.

metricSourceNamestringrequired
criteriaobject[]required

Filtering criteria for the metric source

typestringrequired

Type of event criterion for filtering metrics. Options include value, metadata, user, and user_custom; in Warehouse Native, this should always be metadata.

Allowed values:valuemetadatauseruser_custom
columnstring

Optional column specifying which data attribute to filter on.

conditionstringrequired

sql_filter, start_withs, ends_with, after_exposure, and before_exposure are only applicable in Warehouse Native

Allowed values:innot_in=><>=<=is_nullnon_nullcontainsnot_containssql_filterstarts_withends_withafter_exposurebefore_exposureis_trueis_false
valuesstring[]

Optional array of values for the criterion to match against.

nullVacuousOverrideboolean

If true, overrides null values in criterion evaluation.

valueColumnstring
waitForCohortWindowboolean
denominatorCriteriaobject[]

Filtering criteria for the denominator metric source for a ratio, or the start event for a retention metric if useSecondaryRetentionEvent is set

typestringrequired

Type of event criterion for filtering metrics. Options include value, metadata, user, and user_custom; in Warehouse Native, this should always be metadata.

Allowed values:valuemetadatauseruser_custom
columnstring

Optional column specifying which data attribute to filter on.

conditionstringrequired

sql_filter, start_withs, ends_with, after_exposure, and before_exposure are only applicable in Warehouse Native

Allowed values:innot_in=><>=<=is_nullnon_nullcontainsnot_containssql_filterstarts_withends_withafter_exposurebefore_exposureis_trueis_false
valuesstring[]

Optional array of values for the criterion to match against.

nullVacuousOverrideboolean

If true, overrides null values in criterion evaluation.

denominatorAggregationstring

Allowed: count┃sum┃mean┃daily_participation┃ratio┃funnel┃count_distinct┃percentile

Allowed values:countsummeandaily_participationratiofunnelcount_distinctpercentilefirst_valuelatest_valueretentionmaxmincomposite
denominatorCustomRollupEndnumber

Custom end window for ratio denominator unit count metrics with "custom" rollup time window. Measured in days or minutes depending on the "denominatorCustomRollupMeasureInMinutes" flag.

Constraints:format: double
denominatorCustomRollupStartnumber

Custom start window for ratio denominator unit count metrics with "custom" rollup time window. Measured in days or minutes depending on the "denominatorCustomRollupMeasureInMinutes" flag.

Constraints:format: double
denominatorMetricSourceNamestring

Name of the metric source for the denominator of a ratio, or the start event for a retention metric if useSecondaryRetentionEvent is set

denominatorRollupTimeWindowstring

Rollup-mode for ratio denominator unit count metrics. Allowed values: "daily" for daily participation rate, "max" for one-time event, "custom" for a custom attribution window

denominatorValueColumnstring

Column name for the denominator’s value.

funnelCalculationWindownumber

Duration for counting funnel events in days.

Constraints:format: double
funnelCountDistinctstring

Allowed: users┃sessions for distinct count method in funnel events.

Allowed values:sessionsusers
funnelEventsobject[]

List of funnel events with associated criteria and identifiers.

criteriaobject[]

Optional array of criteria to filter the funnel events, defined by various types and conditions.

typestringrequired

Type of event criterion for filtering metrics. Options include value, metadata, user, and user_custom; in Warehouse Native, this should always be metadata.

Allowed values:valuemetadatauseruser_custom
columnstring

Optional column specifying which data attribute to filter on.

conditionstringrequired

sql_filter, start_withs, ends_with, after_exposure, and before_exposure are only applicable in Warehouse Native

Allowed values:innot_in=><>=<=is_nullnon_nullcontainsnot_containssql_filterstarts_withends_withafter_exposurebefore_exposureis_trueis_false
valuesstring[]

Optional array of values for the criterion to match against.

nullVacuousOverrideboolean

If true, overrides null values in criterion evaluation.

metricSourceNamestring

Optional name of the metric source associated with the funnel event.

namestring

Optional step name for the funnel event, can be null if not specified.

Constraints:nullable
sessionIdentifierFieldstring

Name of column which being used as session identifier. Funnel event with the same metric source

Constraints:nullable
funnelStartCriteriastring

Allowed: start_event┃exposure to determine funnel start criteria.

Allowed values:start_eventexposure
metricDimensionColumnsstring[]

Specify metadata columns for breaking down metric analysis.

metricDimensionLimitsobject[]

Per-dimension breakdown limits; values beyond the limit are grouped into OTHER.

namestringrequired

Name of the metadata dimension to apply a breakdown limit.

limitintegerrequired

Maximum number of values to retain for this dimension (0-100).

Example:10
Constraints:min: 0max: 100
metricBakeDaysnumber

Number of days for metric baking; specify duration for analysis.

Constraints:format: double
loadingWindownumber

Lookback window in days for loading metric data. Defaults to 90 days.

Example:90
Constraints:format: double
numeratorAggregationstring

Aggregation type for numerator; Allowed: count┃sum┃mean┃daily_participation┃ratio┃funnel┃count_distinct┃percentile.

Allowed values:countsummeandaily_participationratiofunnelcount_distinctpercentilefirst_valuelatest_valueretentionmaxmincomposite
valueColumnstring

Deprecated: use metricSources instead. If provided with metricSourceName, this will overwrite all metric sources. Column name representing the metric’s value.

valueThresholdnumber

Threshold value for filtering metrics.

Constraints:format: double
allowNullRatioDenominatorboolean

Include units which do not have a denominator. Only applicable to ratios.

funnelStrictOrderingboolean
funnelUseExposureAsFirstEventboolean
funnelTimestampAllowanceMsnumber
Constraints:format: double
funnelTimeToConvertboolean
winsorizationHighnumber

High threshold for winsorization; must be between 0 and 1.

Constraints:format: doublemin: 0max: 1
winsorizationLownumber

Low threshold for winsorization; must be between 0 and 1.

Constraints:format: doublemin: 0max: 1
winsorizationHighDenominatornumber
Constraints:format: doublemin: 0max: 1
winsorizationLowDenominatornumber
Constraints:format: doublemin: 0max: 1
cupedAttributionWindownumber

Attribution window for CUPED adjustments in days.

Constraints:format: doublenullable
rollupTimeWindowstring

Rollup-mode for unit count metrics. Allowed values: "daily" for daily participation rate, "max" for one-time event, "custom" for a custom attribution window

customRollUpStartnumber

Custom start window for unit count metrics with "custom" rollup time window, or for other metrics with the "Use Cohort Window in Experiments" option on enabled. Measured in days or minutes depending on the "customRollupMeasureInMinutes" flag.

Constraints:format: double
customRollUpEndnumber

Custom end window for unit count metrics with "custom" rollup time window, or for other metrics with the "Use Cohort Window in Experiments" option on enabled. Measured in days or minutes depending on the "customRollupMeasureInMinutes" flag.

Constraints:format: double
onlyIncludeUsersWithConversionEventboolean

Flag to include only users with a conversion event in the metric.

denominatorCustomRollupMeasureInMinutesboolean

Flag to measure the denominator custom rollup window in minutes instead of days.

customRollupMeasureInMinutesboolean

Flag to measure the custom rollup window in minutes instead of days.

percentilenumber

Percentile value for statistical calculations.

Constraints:format: double
useLogTransformboolean

Use log transform for the metric.

useSecondaryRetentionEventboolean

Use a different start and completion event for retention calculations.

retentionEndnumber

Retention end in days.

Constraints:format: double
retentionLengthnumber

Retention lookback window in days.

Constraints:format: double
logTransformBasenumber

Log transform base to be used for the metric.

Constraints:format: doublenullable
capnumber

Maximum cap for metric values.

Constraints:format: double
surrogateMetricMSEnumber

Mean Squared Error for surrogate metric.

Constraints:format: doublenullable
componentsobject[]

Components for composite metrics, defining each component of the formula

operatorstringrequired

Operator for this component

Allowed values:+-
aggregationstring

Aggregation type for this component

Allowed values:countsummeandaily_participationratiofunnelcount_distinctpercentilefirst_valuelatest_valueretentionmaxmincomposite
metricSourceNamestring

Metric source name for this component

namestring

Optional name for this component

Constraints:nullable
criteriaobject[]

Optional filtering criteria for this component

typestringrequired

Type of event criterion for filtering metrics. Options include value, metadata, user, and user_custom; in Warehouse Native, this should always be metadata.

Allowed values:valuemetadatauseruser_custom
columnstring

Optional column specifying which data attribute to filter on.

conditionstringrequired

sql_filter, start_withs, ends_with, after_exposure, and before_exposure are only applicable in Warehouse Native

Allowed values:innot_in=><>=<=is_nullnon_nullcontainsnot_containssql_filterstarts_withends_withafter_exposurebefore_exposureis_trueis_false
valuesstring[]

Optional array of values for the criterion to match against.

nullVacuousOverrideboolean

If true, overrides null values in criterion evaluation.

valueColumnstring

Value column for this component

teamstring

The team associated with the metric, applicable for enterprise environments.

Constraints:nullable
teamIDstring

The team ID associated with the metric, applicable for enterprise environments.

Constraints:nullable
dryRunboolean

Skips persisting the metric (used to validate that inputs are correct)

idstringrequired

Unique identifier for the metric, used for referencing within the system.

Example:metricId
isHiddenboolean

Indicates if the metric is hidden from the user interface.

Example:false
lineageobjectrequired
eventsstring[]required

List of event names that contribute to the metric’s calculation.

Example:["event1","event2"]
metricsstring[]required

List of metric names that are part of this metric’s lineage.

Example:["metric1","metric2"]
creatorNamestring

Name of the person who created the metric, if available.

Example:creatorName
Constraints:nullable
creatorEmailstring

Email address of the metric creator for contact purposes.

Example:creatorEmail
Constraints:nullable
createdTimenumber

Timestamp indicating when the metric was created.

Example:1716230400
Constraints:format: double
lastModifierIDstring

ID of the last modifier.

Constraints:nullable
lastModifiedTimenumber

Time of the last modification to this metric.

Constraints:format: doublenullable
lastModifierEmailstring

Email of the last modifier.

Constraints:nullable
lastModifierNamestring

Name of the last modifier.

Constraints:nullable
scheduledReloadHourinteger

Warehouse Native only - UTC hour at which to run scheduled metric reloads.

Constraints:format: int64nullablemin: 0max: 23
scheduledReloadDaysinteger[]

Warehouse Native only - days on which to run scheduled metric reloads from 0 to 6, 0 meaning Sunday. Null to run reloads on all days.

Constraints:nullable
ownerobject

Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.

Example:{"ownerID":"user123","ownerType":"USER","ownerName":"John Doe","ownerEmail":"owner123@test.com"}
ownerIDstring

ID of the owner

Example:abc123
ownerTypestring

Type of the owner (e.g., SDK_KEY or USER)

Example:USER
ownerNamestring

The name of the owner. This field is optional.

Example:John Doe
ownerEmailstring

The email of the owner. This field is optional.

permalinkstringrequired

A permalink to this metric in the Statsig Console.

Constraints:format: uri
paginationobjectrequired

Pagination metadata for checking if there is next page for example.

Show child attributes
itemsPerPagenumberrequired
Constraints:format: double
pageNumbernumberrequired
Constraints:format: double
nextPagestringrequired
Constraints:nullable
previousPagestringrequired
Constraints:nullable
totalItemsnumber
Constraints:format: double
allstring
401· This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx
statusintegerrequired
Allowed values:401
messagestringrequired

Was this helpful?