Skip to content

MetricRep.md

Latest commit

 

History

History
104 lines (80 loc) · 6.42 KB

MetricRep.md

File metadata and controls

104 lines (80 loc) · 6.42 KB
Raw

MetricRep

Properties

Name Type Description Notes
experimentCount Integer The number of experiments using this metric [optional]
metricGroupCount Integer The number of metric groups using this metric [optional]
activeExperimentCount Integer The number of active experiments using this metric [optional]
activeGuardedRolloutCount Integer The number of active guarded rollouts using this metric [optional]
id String The ID of this metric
versionId String The version ID of the metric
version Integer Version of the metric [optional]
key String A unique key to reference the metric
name String A human-friendly name for the metric
kind KindEnum The kind of event the metric tracks
attachedFlagCount Integer The number of feature flags currently attached to this metric [optional]
links Map<String, Link> The location and content type of related resources
site Link [optional]
access Access [optional]
tags List<String> Tags for the metric
creationDate Long
lastModified Modification [optional]
maintainerId String The ID of the member who maintains this metric [optional]
maintainer MemberSummary [optional]
description String Description of the metric [optional]
category String The category of the metric [optional]
isNumeric Boolean For custom and trace metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>). [optional]
successCriteria SuccessCriteriaEnum For custom and trace metrics, the success criteria [optional]
unit String For numeric custom and trace metrics, the unit of measure [optional]
eventKey String For custom metrics, the event key to use in your code [optional]
randomizationUnits List<String> Deprecated, use <code>analysisUnits</code> instead. [optional]
analysisUnits List<String> An array of analysis units allowed for this metric. [optional]
filters Filter [optional]
unitAggregationType UnitAggregationTypeEnum The method by which multiple unit event values are aggregated [optional]
analysisType AnalysisTypeEnum The method for analyzing metric events [optional]
percentileValue Integer The percentile for the analysis method. An integer denoting the target percentile between 0 and 100. Required when <code>analysisType</code> is <code>percentile</code>. [optional]
eventDefault MetricEventDefaultRep [optional]
dataSource MetricDataSourceRefRep
lastSeen Long [optional]
archived Boolean Whether the metric version is archived [optional]
archivedAt Long [optional]
selector String For click metrics, the CSS selectors [optional]
urls List<Map<String, Object>> [optional]
windowStartOffset Long Not yet implemented - The start of the measurement window, in milliseconds relative to the unit's first exposure to a flag variation [optional]
windowEndOffset Long Not yet implemented - The end of the measurement window, in milliseconds relative to the unit's first exposure to a flag variation [optional]
winsorLowerPercentile BigDecimal Lower winsorization percentile, expressed as a percent in the open interval (0, 100). When both bounds are set, defines a two-sided clamp range. Otherwise lower-only winsorization. [optional]
winsorUpperPercentile BigDecimal Upper winsorization percentile, expressed as a percent in the open interval (0, 100). When both bounds are set, must be greater than winsorLowerPercentile. [optional]
winsorExcludeImputed Boolean Deprecated and ignored. Use winsorIncludeImputed instead. [optional]
winsorIncludeImputed Boolean When true, the percentile bound calculation includes imputed zeros. Only meaningful when at least one bound is set and the metric includes units that didn't send events. [optional]
traceQuery String For trace metrics, the trace query to use for the metric. [optional]
traceValueLocation String For trace metrics, the location in the trace to use for numeric values. [optional]
denominator MetricDenominatorRep [optional]
experiments List<DependentExperimentRep> [optional]
metricGroups List<DependentMetricGroupRep> Metric groups that use this metric [optional]
lastUsedInExperiment DependentExperimentRep [optional]
lastUsedInGuardedRollout DependentMeasuredRolloutRep [optional]
isActive Boolean Whether the metric is active [optional]
attachedFeatures List<FlagListingRep> Details on the flags attached to this metric [optional]

Enum: KindEnum

Name Value
PAGEVIEW "pageview"
CLICK "click"
CUSTOM "custom"
TRACE "trace"

Enum: SuccessCriteriaEnum

Name Value
HIGHER_THAN_BASELINE "HigherThanBaseline"
LOWER_THAN_BASELINE "LowerThanBaseline"

Enum: UnitAggregationTypeEnum

Name Value
AVERAGE "average"
SUM "sum"
COUNT_DISTINCT "count_distinct"

Enum: AnalysisTypeEnum

Name Value
MEAN "mean"
PERCENTILE "percentile"