Skip to content

Latest commit

 

History

History
88 lines (51 loc) · 3.55 KB

MetricRep.md

File metadata and controls

88 lines (51 loc) · 3.55 KB

LaunchDarklyApi.MetricRep

Properties

Name Type Description Notes
experimentCount Number The number of experiments using this metric [optional]
metricGroupCount Number The number of metric groups using this metric [optional]
id String The ID of this metric
versionId String The version ID of the metric
key String A unique key to reference the metric
name String A human-friendly name for the metric
kind String The kind of event the metric tracks
attachedFlagCount Number The number of feature flags currently attached to this metric [optional]
links {String: Link} The location and content type of related resources
site Link [optional]
access Access [optional]
tags [String] Tags for the metric
creationDate Number
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 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 String For custom metrics, the success criteria [optional]
unit String For numeric custom metrics, the unit of measure [optional]
eventKey String For custom metrics, the event key to use in your code [optional]
randomizationUnits [String] An array of randomization units allowed for this metric [optional]
unitAggregationType String The method by which multiple unit event values are aggregated [optional]
analysisType String The method for analyzing metric events [optional]
percentileValue Number 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]
experiments [DependentExperimentRep] [optional]
metricGroups [DependentMetricGroupRep] Metric groups that use this metric [optional]
isActive Boolean Whether the metric is active [optional]
attachedFeatures [FlagListingRep] Details on the flags attached to this metric [optional]
version Number Version of the metric [optional]
selector String For click metrics, the CSS selectors [optional]
urls [Object] [optional]

Enum: KindEnum

  • pageview (value: "pageview")

  • click (value: "click")

  • custom (value: "custom")

Enum: SuccessCriteriaEnum

  • HigherThanBaseline (value: "HigherThanBaseline")

  • LowerThanBaseline (value: "LowerThanBaseline")

Enum: UnitAggregationTypeEnum

  • average (value: "average")

  • sum (value: "sum")

Enum: AnalysisTypeEnum

  • mean (value: "mean")

  • percentile (value: "percentile")