MetricPost.md

MetricPost

Properties

Name	Type	Description	Notes
key	String	A unique key to reference the metric
name	String	A human-friendly name for the metric	[optional]
description	String	Description of the metric	[optional]
kind	KindEnum	The kind of event your metric will track
selector	String	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]
isNumeric	Boolean	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 metrics only.	[optional]
unit	String	The unit of measure. Applicable for numeric custom metrics only.	[optional]
eventKey	String	The event key to use in your code. Required for custom conversion/binary and custom numeric metrics only.	[optional]
successCriteria	SuccessCriteriaEnum	Success criteria. Required for custom numeric metrics, optional for custom conversion metrics.	[optional]
tags	List<String>	Tags for the metric	[optional]
randomizationUnits	List<String>	An array of randomization units allowed for this metric	[optional]
maintainerId	String	The ID of the member who maintains this metric	[optional]
unitAggregationType	UnitAggregationTypeEnum	The method by which multiple unit event values are aggregated	[optional]
analysisType	String	The method for analyzing metric events	[optional]
percentileValue	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]
eventDefault	MetricEventDefaultRep		[optional]
dataSource	MetricDataSourceRefRep		[optional]
filters	EventFilter		[optional]

Enum: KindEnum

Name	Value
PAGEVIEW	"pageview"
CLICK	"click"
CUSTOM	"custom"

Enum: SuccessCriteriaEnum

Name	Value
HIGHER_THAN_BASELINE	"HigherThanBaseline"
LOWER_THAN_BASELINE	"LowerThanBaseline"

Enum: UnitAggregationTypeEnum

Name	Value
AVERAGE	"average"
SUM	"sum"