id |
str |
The ID of this metric |
|
version_id |
str |
The version ID of the metric |
|
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 |
|
links |
{str: (Link,)} |
The location and content type of related resources |
|
tags |
[str] |
Tags for the metric |
|
creation_date |
int |
|
|
experiment_count |
int |
The number of experiments using this metric |
[optional] |
metric_group_count |
int |
The number of metric groups using this metric |
[optional] |
attached_flag_count |
int |
The number of feature flags currently attached to this metric |
[optional] |
site |
Link |
|
[optional] |
access |
Access |
|
[optional] |
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 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 metrics, the success criteria |
[optional] |
unit |
str |
For numeric custom metrics, the unit of measure |
[optional] |
event_key |
str |
For custom metrics, the event key to use in your code |
[optional] |
randomization_units |
[str] |
An array of randomization units allowed for 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] |
experiments |
DependentExperimentListRep |
|
[optional] |
metric_groups |
[DependentMetricGroupRep] |
Metric groups that use this metric |
[optional] |
is_active |
bool |
Whether the metric is active |
[optional] |
attached_features |
[FlagListingRep] |
Details on the flags attached to this metric |
[optional] |
version |
int |
Version of the metric |
[optional] |
selector |
str |
For click metrics, the CSS selectors |
[optional] |
urls |
UrlMatchers |
|
[optional] |
any string name |
bool, date, datetime, dict, float, int, list, str, none_type |
any string name can be used but the value must be the correct type |
[optional] |