Skip to content

MetricPost.md

Latest commit

 

History

History
58 lines (49 loc) · 4.59 KB

MetricPost.md

File metadata and controls

58 lines (49 loc) · 4.59 KB
Raw

MetricPost

Properties

Name Type Description Notes
key str A unique key to reference the metric
name str A human-friendly name for the metric [optional]
description str Description of the metric [optional]
kind str The kind of event your metric will track
selector str One or more CSS selectors. Required for click metrics only. [optional]
urls List[UrlPost] One or more target URLs. Required for click and pageview metrics only. [optional]
is_numeric bool 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>). Required for custom and trace metrics only. [optional]
unit str The unit of measure. Applicable for numeric custom and trace metrics only. [optional]
event_key str The event key to use in your code. Required for custom conversion/binary and custom numeric metrics only. [optional]
success_criteria str Success criteria. Required for custom and trace numeric metrics, optional for custom and trace conversion metrics. [optional]
tags List[str] Tags for the metric [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]
maintainer_id str The ID of the member who maintains this metric [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 [optional]
filters EventFilter [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 The trace query to use for the metric. Required for trace metrics. [optional]
trace_value_location str The location in the trace to use for numeric values. Required for numeric trace metrics. [optional]
unit_aggregation_field str The warehouse column to use for counting distinct values. Required when the unitAggregationType is count_distinct. [optional]
denominator DenominatorPost [optional]

Example

from launchdarkly_api.models.metric_post import MetricPost

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

# convert the object into a dict
metric_post_dict = metric_post_instance.to_dict()
# create an instance of MetricPost from a dict
metric_post_from_dict = MetricPost.from_dict(metric_post_dict)

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