Skip to content

Latest commit

 

History

History
102 lines (96 loc) · 5.41 KB

MetricRep.md

File metadata and controls

102 lines (96 loc) · 5.41 KB

LaunchDarklyApi::MetricRep

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]
active_experiment_count Integer The number of active experiments using this metric [optional]
active_guarded_rollout_count Integer The number of active guarded rollouts using this metric [optional]
_id String The ID of this metric
_version_id 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 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]
category String The category 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]
filters Filter [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]
data_source MetricDataSourceRefRep
last_seen Integer [optional]
archived Boolean Whether the metric version is archived [optional]
archived_at Integer [optional]
selector String For click metrics, the CSS selectors [optional]
urls Array<Hash> [optional]
experiments Array<DependentExperimentRep> [optional]
metric_groups Array<DependentMetricGroupRep> Metric groups that use this metric [optional]
last_used_in_experiment DependentExperimentRep [optional]
last_used_in_guarded_rollout DependentMeasuredRolloutRep [optional]
is_active Boolean Whether the metric is active [optional]
_attached_features Array<FlagListingRep> Details on the flags attached to this metric [optional]

Example

require 'launchdarkly_api'

instance = LaunchDarklyApi::MetricRep.new(
  experiment_count: 0,
  metric_group_count: 0,
  active_experiment_count: 2,
  active_guarded_rollout_count: 1,
  _id: 5902deadbeef667524a01290,
  _version_id: version-id-123abc,
  _version: 1,
  key: metric-key-123abc,
  name: My metric,
  kind: custom,
  _attached_flag_count: 0,
  _links: {&quot;parent&quot;:{&quot;href&quot;:&quot;/api/v2/metrics/my-project&quot;,&quot;type&quot;:&quot;application/json&quot;},&quot;self&quot;:{&quot;href&quot;:&quot;/api/v2/metrics/my-project/my-metric&quot;,&quot;type&quot;:&quot;application/json&quot;}},
  _site: null,
  _access: null,
  tags: [],
  _creation_date: null,
  last_modified: null,
  maintainer_id: 569fdeadbeef1644facecafe,
  _maintainer: null,
  description: null,
  category: Error monitoring,
  is_numeric: true,
  success_criteria: null,
  unit: null,
  event_key: Order placed,
  randomization_units: [&quot;user&quot;],
  filters: null,
  unit_aggregation_type: average,
  analysis_type: mean,
  percentile_value: 95,
  event_default: null,
  data_source: null,
  last_seen: null,
  archived: null,
  archived_at: null,
  selector: null,
  urls: null,
  experiments: null,
  metric_groups: null,
  last_used_in_experiment: null,
  last_used_in_guarded_rollout: null,
  is_active: true,
  _attached_features: null
)