Skip to content

MetricRep.md

Latest commit

 

History

History
81 lines (72 loc) · 6.01 KB

MetricRep.md

File metadata and controls

81 lines (72 loc) · 6.01 KB
Raw

MetricRep

Properties

Name Type Description Notes
experiment_count int The number of experiments using this metric [optional]
metric_group_count int The number of metric groups using this metric [optional]
active_experiment_count int The number of active experiments using this metric [optional]
active_guarded_rollout_count int The number of active guarded rollouts using this metric [optional]
id str The ID of this metric
version_id str The version ID of the metric
version int Version of the metric [optional]
key str A unique key to reference the metric
name str A human-friendly name for the metric
kind str The kind of event the metric tracks
attached_flag_count int The number of feature flags currently attached to this metric [optional]
links Dict[str, Link] The location and content type of related resources
site Link [optional]
access Access [optional]
tags List[str] Tags for the metric
creation_date int
last_modified Modification [optional]
maintainer_id str The ID of the member who maintains this metric [optional]
maintainer MemberSummary [optional]
description str Description of the metric [optional]
category str The category of the metric [optional]
is_numeric bool 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]
success_criteria str For custom and trace metrics, the success criteria [optional]
unit str For numeric custom and trace metrics, the unit of measure [optional]
event_key str For custom metrics, the event key to use in your code [optional]
randomization_units List[str] Deprecated, use <code>analysisUnits</code> instead. [optional]
analysis_units List[str] An array of analysis units allowed for this metric. [optional]
filters Filter [optional]
unit_aggregation_type str The method by which multiple unit event values are aggregated [optional]
analysis_type str The method for analyzing metric events [optional]
percentile_value int 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 int [optional]
archived bool Whether the metric version is archived [optional]
archived_at int [optional]
selector str For click metrics, the CSS selectors [optional]
urls List[Dict[str, object]] [optional]
window_start_offset int Not yet implemented - The start of the measurement window, in milliseconds relative to the unit's first exposure to a flag variation [optional]
window_end_offset int Not yet implemented - The end of the measurement window, in milliseconds relative to the unit's first exposure to a flag variation [optional]
winsor_lower_percentile float 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]
winsor_upper_percentile float Upper winsorization percentile, expressed as a percent in the open interval (0, 100). When both bounds are set, must be greater than winsorLowerPercentile. [optional]
winsor_exclude_imputed bool Deprecated and ignored. Use winsorIncludeImputed instead. [optional]
winsor_include_imputed bool 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]
trace_query str For trace metrics, the trace query to use for the metric. [optional]
trace_value_location str For trace metrics, the location in the trace to use for numeric values. [optional]
denominator MetricDenominatorRep [optional]
experiments List[DependentExperimentRep] [optional]
metric_groups List[DependentMetricGroupRep] Metric groups that use this metric [optional]
last_used_in_experiment DependentExperimentRep [optional]
last_used_in_guarded_rollout DependentMeasuredRolloutRep [optional]
is_active bool Whether the metric is active [optional]
attached_features List[FlagListingRep] Details on the flags attached to this metric [optional]

Example

from launchdarkly_api.models.metric_rep import MetricRep

# TODO update the JSON string below
json = "{}"
# create an instance of MetricRep from a JSON string
metric_rep_instance = MetricRep.from_json(json)
# print the JSON string representation of the object
print(MetricRep.to_json())

# convert the object into a dict
metric_rep_dict = metric_rep_instance.to_dict()
# create an instance of MetricRep from a dict
metric_rep_from_dict = MetricRep.from_dict(metric_rep_dict)

[Back to Model list] [Back to API list] [Back to README]