MetricPost.md

MetricPost

Properties

Name	Type	Description	Notes
key	string	A unique key to reference the metric	[default to undefined]
name	string	A human-friendly name for the metric	[optional] [default to undefined]
description	string	Description of the metric	[optional] [default to undefined]
kind	string	The kind of event your metric will track	[default to undefined]
selector	string	One or more CSS selectors. Required for click metrics only.	[optional] [default to undefined]
urls	Array<UrlPost>	One or more target URLs. Required for click and pageview metrics only.	[optional] [default to undefined]
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 and trace metrics only.	[optional] [default to undefined]
unit	string	The unit of measure. Applicable for numeric custom and trace metrics only.	[optional] [default to undefined]
eventKey	string	The event key to use in your code. Required for custom conversion/binary and custom numeric metrics only.	[optional] [default to undefined]
successCriteria	string	Success criteria. Required for custom and trace numeric metrics, optional for custom and trace conversion metrics.	[optional] [default to undefined]
tags	Array<string>	Tags for the metric	[optional] [default to undefined]
randomizationUnits	Array<string>	Deprecated, use <code>analysisUnits</code> instead.	[optional] [default to undefined]
analysisUnits	Array<string>	An array of analysis units allowed for this metric.	[optional] [default to undefined]
maintainerId	string	The ID of the member who maintains this metric	[optional] [default to undefined]
unitAggregationType	string	The method by which multiple unit event values are aggregated	[optional] [default to undefined]
analysisType	string	The method for analyzing metric events	[optional] [default to undefined]
percentileValue	number	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] [default to undefined]
eventDefault	MetricEventDefaultRep		[optional] [default to undefined]
dataSource	MetricDataSourceRefRep		[optional] [default to undefined]
filters	EventFilter		[optional] [default to undefined]
windowStartOffset	number	Not yet implemented - The start of the measurement window, in milliseconds relative to the unit&#39;s first exposure to a flag variation	[optional] [default to undefined]
windowEndOffset	number	Not yet implemented - The end of the measurement window, in milliseconds relative to the unit&#39;s first exposure to a flag variation	[optional] [default to undefined]
winsorLowerPercentile	number	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] [default to undefined]
winsorUpperPercentile	number	Upper winsorization percentile, expressed as a percent in the open interval (0, 100). When both bounds are set, must be greater than winsorLowerPercentile.	[optional] [default to undefined]
winsorIncludeImputed	boolean	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&#39;t send events.	[optional] [default to undefined]
traceQuery	string	The trace query to use for the metric. Required for trace metrics.	[optional] [default to undefined]
traceValueLocation	string	The location in the trace to use for numeric values. Required for numeric trace metrics.	[optional] [default to undefined]
unitAggregationField	string	The warehouse column to use for counting distinct values. Required when the unitAggregationType is count_distinct.	[optional] [default to undefined]
valueColumn	string	For numeric warehouse-native metrics, the column holding the numeric value. Overrides the value column mapped on the data source.	[optional] [default to undefined]
denominator	DenominatorPost		[optional] [default to undefined]

Example

import { MetricPost } from 'launchdarkly-api-typescript';

const instance: MetricPost = {
    key,
    name,
    description,
    kind,
    selector,
    urls,
    isNumeric,
    unit,
    eventKey,
    successCriteria,
    tags,
    randomizationUnits,
    analysisUnits,
    maintainerId,
    unitAggregationType,
    analysisType,
    percentileValue,
    eventDefault,
    dataSource,
    filters,
    windowStartOffset,
    windowEndOffset,
    winsorLowerPercentile,
    winsorUpperPercentile,
    winsorIncludeImputed,
    traceQuery,
    traceValueLocation,
    unitAggregationField,
    valueColumn,
    denominator,
};

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