Type Alias FormattedInAppMetricDefinition

type FormattedInAppMetricDefinition = {
    analysisTypes: AnalysisTypeEnum[];
    breakDownDimensions?: BreakDownDimension[];
    categories?: Categories[];
    comparisonPeriods?: AggregationFrequencyEnum[];
    description?: string;
    dimension: string;
    glossaryId?: string;
    measure: string;
    name: string;
    nextExecutionOffset?: number;
    status?: StatusEnum;
    upwardIs?: UpwardIsEnum;
}
Index
analysisTypes: AnalysisTypeEnum[]
breakDownDimensions?: BreakDownDimension[]
categories?: Categories[]
comparisonPeriods?: AggregationFrequencyEnum[]
description?: string

A description of the in-app metric.

dimension: string
glossaryId?: string

The ID of the glossary that the in-app metric belongs to.

measure: string
name: string
nextExecutionOffset?: number

Number of days to offset the execution of analyses for this aggregation period.

status?: StatusEnum

Status of the in app metrics (0 - inactive, 1 - active).

upwardIs?: UpwardIsEnum

Indicates whether an increase in the metric is considered neutral (0), positive (1) or negative (-1).