MetricInGroupRep.md

LaunchDarklyApi::MetricInGroupRep

Properties

Name	Type	Description	Notes
key	String	The metric key
_version_id	String	The version ID of the metric	[optional]
name	String	The metric name
kind	String	The kind of event the metric tracks
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]
unit_aggregation_type	String	The type of unit aggregation to use for the metric	[optional]
analysis_type	String	The method for analyzing metric events	[optional]
event_key	String	The event key sent with the metric. Only relevant for custom metrics.	[optional]
_links	Hash<String, Link>	The location and content type of related resources
name_in_group	String	Name of the metric when used within the associated metric group. Can be different from the original name of the metric. Required if and only if the metric group is a <code>funnel</code>.	[optional]
randomization_units	Array<String>	Deprecated, use <code>analysisUnits</code> instead.	[optional]
analysis_units	Array<String>	An array of analysis units allowed for this metric.	[optional]

Example

require 'launchdarkly_api'

instance = LaunchDarklyApi::MetricInGroupRep.new(
  key: metric-key-123abc,
  _version_id: version-id-123abc,
  name: Example metric,
  kind: custom,
  is_numeric: true,
  unit_aggregation_type: sum,
  analysis_type: mean,
  event_key: event-key-123abc,
  _links: {"self":{"href":"/api/v2/metrics/my-project/my-metric","type":"application/json"}},
  name_in_group: Step 1,
  randomization_units: ["user"],
  analysis_units: ["user"]
)