MetricListingRep.md

LaunchDarklyApi::MetricListingRep

Properties

Name	Type	Description	Notes
experiment_count	Integer	The number of experiments using this metric	[optional]
metric_group_count	Integer	The number of metric groups using this metric	[optional]
_id	String	The ID of this metric
_version_id	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
_attached_flag_count	Integer	The number of feature flags currently attached to this metric	[optional]
_links	Hash<String, Link>	The location and content type of related resources
_site	Link		[optional]
_access	Access		[optional]
tags	Array<String>	Tags for the metric
_creation_date	Integer
last_modified	Modification		[optional]
maintainer_id	String	The ID of the member who maintains this metric	[optional]
_maintainer	MemberSummary		[optional]
description	String	Description of the metric	[optional]
is_numeric	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]
success_criteria	String	For custom metrics, the success criteria	[optional]
unit	String	For numeric custom metrics, the unit of measure	[optional]
event_key	String	For custom metrics, the event key to use in your code	[optional]
randomization_units	Array<String>	An array of randomization units allowed for this metric	[optional]
unit_aggregation_type	String	The method by which multiple unit event values are aggregated	[optional]
analysis_type	String	The method for analyzing metric events	[optional]
percentile_value	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]
event_default	MetricEventDefaultRep		[optional]

Example

require 'launchdarkly_api'

instance = LaunchDarklyApi::MetricListingRep.new(
  experiment_count: 0,
  metric_group_count: 0,
  _id: 5902deadbeef667524a01290,
  _version_id: version-id-123abc,
  key: metric-key-123abc,
  name: My metric,
  kind: custom,
  _attached_flag_count: 0,
  _links: {"parent":{"href":"/api/v2/metrics/my-project","type":"application/json"},"self":{"href":"/api/v2/metrics/my-project/my-metric","type":"application/json"}},
  _site: null,
  _access: null,
  tags: [],
  _creation_date: null,
  last_modified: null,
  maintainer_id: 569fdeadbeef1644facecafe,
  _maintainer: null,
  description: null,
  is_numeric: true,
  success_criteria: null,
  unit: null,
  event_key: null,
  randomization_units: ["user"],
  unit_aggregation_type: average,
  analysis_type: mean,
  percentile_value: 95,
  event_default: null
)