# Update aggregate - Operation ID: `analytics2-aggregate-update` - HTTP method: `PUT` - Path: `/analytics/{Namespace}/aggregates/{AggregateIdentifier}` - [Human-readable API reference](https://hub.synerise.com/api-reference/data-management#tag/Analytics:-Aggregates/operation/analytics2-aggregate-update) ## Self-contained OpenAPI method The fenced document below contains this method's documentation and all of its local references. It is self-contained; no category or master specification fetch is required. ```yaml openapi: 3.0.0 info: title: Synerise Public API version: 1.9.1 paths: /analytics/{Namespace}/aggregates/{AggregateIdentifier}: put: tags: - "Analytics: Aggregates" summary: Update aggregate description: | Update an aggregate. --- **API consumers:** Synerise User, Workspace (Business Profile) **API key permissions required (at least one):** `ANALYTICS_BACKEND_AGGREGATES_UPDATE`, `ANALYTICS_BACKEND_AGGREGATE_UPDATE` **User role permission required:** `analytics_aggregates: update` operationId: analytics2-aggregate-update parameters: - name: Namespace in: path description: Namespace. Currently, only `profiles` is available. required: true style: simple explode: false schema: type: string enum: - profiles - name: AggregateIdentifier in: path description: Aggregate identifier (UUID or numeric ID) required: true style: simple explode: false schema: type: string requestBody: content: application/json: schema: type: object description: Definition of the aggregate properties: analysis: description: | Definition of the aggregate. In `attribute`, define the attribute that you want to analyze. discriminator: propertyName: aggregateType mapping: AGGREGATE: "#/components/schemas/analytics-ClientAggregate" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregate" oneOf: - type: object description: The definition of an aggregate properties: aggregateType: x-class-name: ClientAggregateAggregateType type: string description: An aggregate with a profile context enum: - AGGREGATE id: type: integer format: int64 minimum: 0 description: Unique numeric ID of the analysis name: type: string description: Name of the resource description: type: string description: Description of the resource uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c type: type: string description: | The type of calculation. - COUNT allows you to count the total number of the entities that meet the filters. - COUNT_DISTINCT allows you to count the total number of distinct (unique) attribute values in entities which match the filters. - SUM, MIN, MAX, MEDIAN, QUANTILE (requires `level`) and AVG allow you to perform calculations on numerical-value parameters within the entities that meet the filters. - EXISTS checks the existence of at least a single entity that meets the filters and returns 1 when "true" or 0 when "false". - LAST and LAST_MULTI (requires `size`) retrieve the newest matching data. - FIRST and FIRST_MULTI (requires `size`) retrieve the oldest matching data. - LAST_TIME and FIRST_TIME (running aggregates only; require `timeWindow`) retrieve the single newest / oldest matching value from events within the time window preceding the currently evaluated event. - LAST_MULTI_TIME and FIRST_MULTI_TIME (running aggregates only; require `size` and `timeWindow`) retrieve the newest / oldest matching data from events within the time window preceding the currently evaluated event. enum: - AVG - SUM - MIN - MAX - COUNT - MEDIAN - QUANTILE - COUNT_DISTINCT - LAST - FIRST - EXISTS - FIRST_MULTI - LAST_MULTI - FIRST_TIME - LAST_TIME - FIRST_MULTI_TIME - LAST_MULTI_TIME - TOP - BOTTOM - TOP_MULTI - BOTTOM_MULTI level: type: number format: double nullable: true description: Only applies when `type` is `QUANTILE`. This is the percentile whose value will be the result of the analysis. For example, `0.35` is the 35th percentile. size: type: integer format: int32 minimum: 0 description: Only applies and is required when `type` is *_MULTI. Defines how many results to return. unique: type: boolean description: Only applies when `type`` is *_MULTI. When set to `true``, only unique occurrences of an event parameter are included in the results. dateFilter: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type expressions: type: array description: An array of conditions that the event must meet items: type: object description: The `attribute` object is an event attribute that must exist in the analyzed event. The `constraint` object is a condition that the attribute must meet. properties: constraint: description: | This object defines the logic to apply to the `attribute`, and the values to compare it against (if required). **The analytics engine doesn't check if the data types match - you need to ensure that your data types are consistent in the data you send to the database**. discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintEventConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintEventConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintEventConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintEventConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintEventConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintEventConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintEventConstraint" "NULL": "#/components/schemas/analytics-NullConstraintEventConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintEventConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintEventConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintEventConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintEventConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolConstraintType type: string enum: - BOOL description: Tests a boolean value logic: x-class-name: BoolConstraintLogic type: string description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: title: String zero x-class-name: StringZeroConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: x-class-name: StringZeroConstraintLogic type: string description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: x-class-name: StringOneConstraintType type: string enum: - STRING_ONE description: This type is used to test values that are a single string. logic: x-class-name: StringOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: x-class-name: NumberOneConstraintType type: string enum: - NUMBER_ONE description: This type is used to test values that are a single number logic: x-class-name: NumberOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: x-class-name: NumberTwoConstraintType type: string enum: - NUMBER_TWO description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoConstraintLogic type: string enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: x-class-name: StringArrayConstraintType type: string enum: - STRING_ARRAY description: This type is used to check if a string exists in an array defined in `value` logic: type: string x-class-name: StringArrayConstraintLogic description: You can check if the value from `attribute` is in the array defined in `value` enum: - IN - NOT_IN value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: x-class-name: ArrayStringOneConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED description: "`value` should be an array" logic: x-class-name: ArrayStringOneConstraintLogic type: string description: | - CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullConstraintType description: This type is used to check if a value is null type: string enum: - "NULL" logic: x-class-name: NullConstraintLogic type: string description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: x-class-name: DateZeroConstraintType type: string enum: - DATE_ZERO description: Compare a date from `attribute` to the current date logic: x-class-name: LogicZeroConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR description: Logic to apply to the date from `attribute` required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: x-class-name: DateOneConstraintLogic type: string description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: x-class-name: DateTwoConstraintLogic type: string description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - description: This type is used to check if a date matches a date filter. type: object title: Date filter properties: type: x-class-name: DateFilterConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: x-class-name: DateFilterConstraintLogic type: string enum: - DATE_FILTER description: Checks if the date from `attribute` matches a date filter. value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - constrain - attribute attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type action: type: object description: The analyzed event nullable: true required: - name properties: id: type: integer format: int64 deprecated: true nullable: true description: Deprecated parameter. DO NOT use. Has no effect in create/update requests. name: type: string description: Action name of the event. example: page.visit required: - aggregateType - id - name - description - uuid - type - level - size - unique - dateFilter - expressions - attribute - action - type: object properties: aggregateType: description: An aggregate with an event context x-class-name: RunningAggregateAggregateType type: string enum: - RUNNING_AGGREGATE id: type: integer format: int64 minimum: 0 description: Unique numeric ID of the analysis name: type: string description: Name of the resource description: type: string description: Description of the resource uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c type: type: string description: | The type of calculation. - COUNT allows you to count the total number of the entities that meet the filters. - COUNT_DISTINCT allows you to count the total number of distinct (unique) attribute values in entities which match the filters. - SUM, MIN, MAX, MEDIAN, QUANTILE (requires `level`) and AVG allow you to perform calculations on numerical-value parameters within the entities that meet the filters. - EXISTS checks the existence of at least a single entity that meets the filters and returns 1 when "true" or 0 when "false". - LAST and LAST_MULTI (requires `size`) retrieve the newest matching data. - FIRST and FIRST_MULTI (requires `size`) retrieve the oldest matching data. - LAST_TIME and FIRST_TIME (running aggregates only; require `timeWindow`) retrieve the single newest / oldest matching value from events within the time window preceding the currently evaluated event. - LAST_MULTI_TIME and FIRST_MULTI_TIME (running aggregates only; require `size` and `timeWindow`) retrieve the newest / oldest matching data from events within the time window preceding the currently evaluated event. enum: - AVG - SUM - MIN - MAX - COUNT - MEDIAN - QUANTILE - COUNT_DISTINCT - LAST - FIRST - EXISTS - FIRST_MULTI - LAST_MULTI - FIRST_TIME - LAST_TIME - FIRST_MULTI_TIME - LAST_MULTI_TIME - TOP - BOTTOM - TOP_MULTI - BOTTOM_MULTI level: type: number format: double nullable: true description: Only applies when `type` is `QUANTILE`. This is the percentile whose value will be the result of the analysis. For example, `0.35` is the 35th percentile. size: type: integer format: int32 minimum: 0 description: Only applies and is required when `type` is *_MULTI. Defines how many results to return. unique: type: boolean description: Only applies when `type`` is *_MULTI. When set to `true``, only unique occurrences of an event parameter are included in the results. dateFilter: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type expressions: type: array description: An array of conditions that the event must meet items: type: object description: The `attribute` object is an event attribute that must exist in the analyzed event. The `constraint` object is a condition that the attribute must meet. properties: constraint: description: | This object defines the logic to apply to the `attribute`, and the values to compare it against (if required). **The analytics engine doesn't check if the data types match - you need to ensure that your data types are consistent in the data you send to the database**. discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintEventConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintEventConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintEventConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintEventConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintEventConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintEventConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintEventConstraint" "NULL": "#/components/schemas/analytics-NullConstraintEventConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintEventConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintEventConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintEventConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintEventConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolConstraintType type: string enum: - BOOL description: Tests a boolean value logic: x-class-name: BoolConstraintLogic type: string description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: title: String zero x-class-name: StringZeroConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: x-class-name: StringZeroConstraintLogic type: string description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: x-class-name: StringOneConstraintType type: string enum: - STRING_ONE description: This type is used to test values that are a single string. logic: x-class-name: StringOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: x-class-name: NumberOneConstraintType type: string enum: - NUMBER_ONE description: This type is used to test values that are a single number logic: x-class-name: NumberOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: x-class-name: NumberTwoConstraintType type: string enum: - NUMBER_TWO description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoConstraintLogic type: string enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: x-class-name: StringArrayConstraintType type: string enum: - STRING_ARRAY description: This type is used to check if a string exists in an array defined in `value` logic: type: string x-class-name: StringArrayConstraintLogic description: You can check if the value from `attribute` is in the array defined in `value` enum: - IN - NOT_IN value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: x-class-name: ArrayStringOneConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED description: "`value` should be an array" logic: x-class-name: ArrayStringOneConstraintLogic type: string description: | - CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullConstraintType description: This type is used to check if a value is null type: string enum: - "NULL" logic: x-class-name: NullConstraintLogic type: string description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: x-class-name: DateZeroConstraintType type: string enum: - DATE_ZERO description: Compare a date from `attribute` to the current date logic: x-class-name: LogicZeroConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR description: Logic to apply to the date from `attribute` required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: x-class-name: DateOneConstraintLogic type: string description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: x-class-name: DateTwoConstraintLogic type: string description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - description: This type is used to check if a date matches a date filter. type: object title: Date filter properties: type: x-class-name: DateFilterConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: x-class-name: DateFilterConstraintLogic type: string enum: - DATE_FILTER description: Checks if the date from `attribute` matches a date filter. value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - constrain - attribute attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type action: type: object description: The analyzed event nullable: true required: - name properties: id: type: integer format: int64 deprecated: true nullable: true description: Deprecated parameter. DO NOT use. Has no effect in create/update requests. name: type: string description: Action name of the event. example: page.visit excludeCurrent: type: boolean description: When `false`, data from the event that is the subject of the analysis is analyzed in addition to data of the events that occurred before it. timeWindow: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value required: - aggregateType - id - name - description - uuid - type - level - size - unique - dateFilter - expressions - attribute - action - excludeCurrent isVisibleForClientProfile: type: boolean description: When set to `true`, information about this analysis is shown on a profile's card. aggregateType: type: string enum: - AGGREGATE - RUNNING_AGGREGATE previewDefaultObjectId: type: number format: int64 nullable: true description: The ID of the default profile for generating a preview of the results. inlineAnalytics: type: array description: Analyses added to the request. They can be referenced by their ID in filters and expressions same as other analyses, but are not saved in persistent storage. items: description: An inline analytic definition carried alongside a request so it can be referenced by id without being persisted. oneOf: - type: object x-class-name: InlineExpression x-interface-name-ts: InlineExpression properties: id: type: string format: uuid description: Unique ID of the resource analyticType: type: string enum: - EXPRESSION analysis: discriminator: propertyName: type mapping: EVENT: "#/components/schemas/analytics-EventExpressionEntity" CLIENT: "#/components/schemas/analytics-ClientExpressionEntity" oneOf: - type: object title: Event expression properties: type: type: string enum: - EVENT description: This type of expression can be used to analyze event attributes, including the attributes of the profile that owns the event. action: type: object description: The analyzed event nullable: true required: - name properties: id: type: integer format: int64 deprecated: true nullable: true description: Deprecated parameter. DO NOT use. Has no effect in create/update requests. name: type: string description: Action name of the event. example: page.visit name: type: string description: Name of the resource description: type: string description: Description of the resource expression: description: Structure of the expression. This is a recursive schema - functions can contain more functions. example: type: VALUE title: title value: type: CONSTANT constant: 10 discriminator: propertyName: type mapping: VALUE: "#/components/schemas/analytics-EventExpressionContentEntityValue" FUNCTION: "#/components/schemas/analytics-EventExpressionContentEntityFunction" oneOf: - type: object title: Value description: A value reference in the expression - can reference an event parameter, profile parameter, constant, or variable. properties: type: description: A value reference in the expression - can reference an event parameter, profile parameter, constant, or variable. x-class-name: EventExpressionContentEntityValueType type: string enum: - VALUE title: type: string description: Title of the value value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - title - type - value - type: object title: Function description: | A function in the expression. Arguments are optional depending on function arity: - `arg` - argument for single-argument (unary) functions - `arg1` - first argument for multi-argument functions (binary, ternary) - `arg2` - second argument for multi-argument functions (binary, ternary) - `arg3` - third argument for ternary functions (IF) example: type: FUNCTION function: LN arg: type: VALUE title: title value: type: CONSTANT constant: 10 properties: type: x-class-name: EventExpressionContentEntityFunctionType type: string enum: - FUNCTION function: x-class-name: EventExpressionFunctionType type: string description: | The function to apply. The number of required arguments depends on the function arity: - Nullary (0 args): NOW - Unary (1 arg via `arg`): LN, ABS, CEIL, EXP, FLOOR, ROUND, TO_NUMBER, TO_STRING, DAY_OF_MONTH, DAY_OF_WEEK, DAY_OF_YEAR, HOUR, MONTH, WEEK, YEAR, TO_MONEY, TO_TIMESTAMP, TO_DATE, BRACKET - Binary (2 args via `arg1`, `arg2`): DIVIDE, IF_NULL, MAX, MIN, MOD, MULTIPLY, SUB, SUM, GREATER, GREATER_OR_EQUALS, LESS, LESS_OR_EQUAL, NOT_EQUAL, EQUALS, ADD_YEARS, CONCAT, REGEXP - Ternary (3 args via `arg1`, `arg2`, `arg3`): IF (arg1 - condition; arg2 - return if true; arg3 - return if false) enum: - NOW - LN - ABS - CEIL - EXP - FLOOR - ROUND - TO_NUMBER - TO_STRING - DAY_OF_MONTH - DAY_OF_WEEK - DAY_OF_YEAR - HOUR - MONTH - WEEK - YEAR - TO_MONEY - TO_TIMESTAMP - TO_DATE - BRACKET - DIVIDE - IF_NULL - MAX - MIN - MOD - MULTIPLY - SUB - SUM - GREATER - GREATER_OR_EQUALS - LESS - LESS_OR_EQUAL - NOT_EQUAL - EQUALS - ADD_YEARS - CONCAT - REGEXP - IF arg: type: object description: An argument of the function. This is a recursive schema; an argument can be a function which contains more functions in its arguments. x-codegen-schema: EventExpressionContentEntity arg1: type: object description: An argument of the function. This is a recursive schema; an argument can be a function which contains more functions in its arguments. x-codegen-schema: EventExpressionContentEntity arg2: type: object description: An argument of the function. This is a recursive schema; an argument can be a function which contains more functions in its arguments. x-codegen-schema: EventExpressionContentEntity arg3: type: object description: An argument of the function. This is a recursive schema; an argument can be a function which contains more functions in its arguments. x-codegen-schema: EventExpressionContentEntity required: - type - function required: - expression - name - type - description - type: object title: Profile expression description: Details of a profile expression. In the Synerise Portal, they are called _attribute_ expressions. properties: id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c type: type: string enum: - CLIENT description: This type of expression can be used to analyze profile attributes. name: type: string description: Name of the resource description: type: string description: Description of the resource expression: description: Structure of the expression. This is a recursive schema - functions can contain more functions. example: type: VALUE title: title value: type: CONSTANT constant: 10 discriminator: propertyName: type mapping: VALUE: "#/components/schemas/analytics-ClientExpressionContentEntityValue" FUNCTION: "#/components/schemas/analytics-ClientExpressionContentEntityFunction" oneOf: - type: object title: Value description: A value reference in the expression - can reference a profile parameter, constant, or variable. properties: type: x-class-name: ClientExpressionContentEntityValueType type: string description: A value reference in the expression - can reference a profile parameter, constant, or variable. enum: - VALUE title: type: string description: Title of the value value: oneOf: - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - title - type - value - type: object title: Function description: | A function in the expression. Arguments are optional depending on function arity: - `arg` - argument for single-argument (unary) functions - `arg1` - first argument for multi-argument functions (binary, ternary) - `arg2` - second argument for multi-argument functions (binary, ternary) - `arg3` - third argument for ternary functions (IF) example: type: FUNCTION function: LN arg: type: VALUE title: title value: type: CONSTANT constant: 10 properties: type: x-class-name: ClientExpressionContentEntityFunctionType type: string enum: - FUNCTION function: x-class-name: ClientExpressionFunctionType type: string description: | The function to apply. The number of required arguments depends on the function arity: - Nullary (0 args): NOW - Unary (1 arg via `arg`): LN, ABS, CEIL, EXP, FLOOR, ROUND, TO_NUMBER, TO_STRING, DAY_OF_MONTH, DAY_OF_WEEK, DAY_OF_YEAR, HOUR, MONTH, WEEK, YEAR, TO_MONEY, TO_TIMESTAMP, TO_DATE, BRACKET - Binary (2 args via `arg1`, `arg2`): DIVIDE, IF_NULL, MAX, MIN, MOD, MULTIPLY, SUB, SUM, GREATER, GREATER_OR_EQUALS, LESS, LESS_OR_EQUAL, NOT_EQUAL, EQUALS, ADD_YEARS, CONCAT, REGEXP - Ternary (3 args via `arg1`, `arg2`, `arg3`): IF (arg1 - condition; arg2 - return if true; arg3 - return if false) enum: - NOW - LN - ABS - CEIL - EXP - FLOOR - ROUND - TO_NUMBER - TO_STRING - DAY_OF_MONTH - DAY_OF_WEEK - DAY_OF_YEAR - HOUR - MONTH - WEEK - YEAR - TO_MONEY - TO_TIMESTAMP - TO_DATE - BRACKET - DIVIDE - IF_NULL - MAX - MIN - MOD - MULTIPLY - SUB - SUM - GREATER - GREATER_OR_EQUALS - LESS - LESS_OR_EQUAL - NOT_EQUAL - EQUALS - ADD_YEARS - CONCAT - REGEXP - IF arg: type: object description: An argument of the function. This is a recursive schema; an argument can be a function which contains more functions in its arguments. x-codegen-schema: ClientExpressionContentEntity arg1: type: object description: An argument of the function. This is a recursive schema; an argument can be a function which contains more functions in its arguments. x-codegen-schema: ClientExpressionContentEntity arg2: type: object description: An argument of the function. This is a recursive schema; an argument can be a function which contains more functions in its arguments. x-codegen-schema: ClientExpressionContentEntity arg3: type: object description: An argument of the function. This is a recursive schema; an argument can be a function which contains more functions in its arguments. x-codegen-schema: ClientExpressionContentEntity required: - type - function required: - type - name - expression required: - id - analyticType - analysis - type: object x-class-name: InlineSegmentation x-interface-name-ts: InlineSegmentation properties: id: type: string format: uuid description: Unique ID of the resource analyticType: type: string enum: - SEGMENTATION analysis: type: object description: Definition of the segmentation. properties: id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c title: type: string description: Name of the resource description: type: string description: Description of the resource segments: type: array description: An array of segments in the segmentation. By default, a profile is only included in the first matching segment, even if it meets the filters of the following segments. To change this, use the `unique` parameter. minItems: 1 items: type: object x-class-name: Segment properties: title: type: string description: Name of the segment. If you want to use the segment name (for example, by creating an expression that returns it for use in a filter), the name shouldn't include any whitespace or special characters. description: type: string description: Description of the segment filter: type: object description: | This filter lets you limit the results to profiles that match it. For no filter, leave the object empty. The `expression` object is only used by the Synerise Web Portal. If you're integrating an API, don't send this object or send it empty. If you send `expression` and `expressions`, `expressions` takes priority. properties: matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true expressions: type: array description: Profile filter details. The expressions are applied according to their position in the array. The logical AND/OR operator must be placed between expressions. An empty array means no filters are applied. items: discriminator: propertyName: type mapping: ATTRIBUTE: "#/components/schemas/analytics-AttributeFilterBox" EXPRESSION: "#/components/schemas/analytics-ExpressionFilterBox" FUNNEL: "#/components/schemas/analytics-FunnelFilterBox" OPERATOR: "#/components/schemas/analytics-OperatorFilterBox" oneOf: - type: object properties: type: x-class-name: AttributeFilterBoxType type: string enum: - ATTRIBUTE description: Tests a profile attribute against a condition name: type: string description: Name of the resource matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true attribute: type: object description: The condition to test a profile attribute properties: expressions: type: array description: An array of conditions. All conditions must be met. items: type: object properties: constraint: discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintClientConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintClientConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintClientConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintClientConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintClientConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintClientConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintClientConstraint" "NULL": "#/components/schemas/analytics-NullConstraintClientConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintClientConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintClientConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintClientConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintClientConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolClientConstraintType type: string enum: - BOOL description: Tests a boolean value logic: description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. x-class-name: BoolClientConstraintLogic type: string enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: x-class-name: StringZeroClientConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. x-class-name: StringZeroClientConstraintLogic type: string enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: description: This type is used to test values that are a single string. x-class-name: StringOneClientConstraintType type: string enum: - STRING_ONE logic: description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". x-class-name: StringOneClientConstraintLogic type: string enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: description: This type is used to test values that are a single number x-class-name: NumberOneClientConstraintType type: string enum: - NUMBER_ONE logic: description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. x-class-name: NumberOneClientConstraintLogic type: string enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. x-class-name: NumberTwoClientConstraintType type: string enum: - NUMBER_TWO logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoClientConstraintLogic type: string enum: - BETWEEN value1: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue value2: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: description: This type is used to check if a string exists in an array defined in `value` x-class-name: StringArrayClientConstraintType type: string enum: - STRING_ARRAY logic: description: You can check if the value from `attribute` is in the array defined in `value` x-class-name: StringArrayClientConstraintLogic type: string enum: - IN - NOT_IN value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: description: "`value` should be an array" x-class-name: ArrayStringOneClientConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED logic: description: "- CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` " x-class-name: ArrayStringOneClientConstraintLogic type: string enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullClientConstraintType type: string enum: - "NULL" description: This type is used to check if a value is null logic: description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. x-class-name: NullClientConstraintLogic type: string enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: description: Compare a date from `attribute` to the current date x-class-name: DateZeroClientConstraintType type: string enum: - DATE_ZERO logic: description: Logic to apply to the date from `attribute` x-class-name: DateZeroClientConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneClientConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. x-class-name: DateOneClientConstraintLogic type: string enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoClientConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. x-class-name: DateTwoClientConstraintLogic type: string enum: - BETWEEN value1: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue value2: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Date filter description: This type is used to check if a date matches a date filter. properties: type: x-class-name: DateFilterClientConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: description: Checks if the date from `attribute` matches a date filter. x-class-name: DateFilterClientConstraintLogic type: string enum: - DATE_FILTER value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - expressions - description: A condition to test type: object properties: type: description: A condition to test x-class-name: ExpressionFilterBoxType type: string enum: - EXPRESSION name: type: string matching: type: boolean expressions: $ref: "#/components/schemas/analytics-FilterBox" required: - type - expressions - type: object properties: type: description: Tests against a funnel x-class-name: ExpressionFilterBoxType type: string enum: - FUNNEL name: type: string description: Name of the resource matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true funnel: type: object description: Funnel conditions properties: title: type: string description: Title of the funnel. completedWithin: type: object description: | Time constraint for completing all the steps in the funnel. Timer starts when the first step is triggered. - `period` sets the time unit - `value` sets the number of time units properties: period: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: description: The number of time units type: number format: int64 dateFilter: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type steps: type: array minItems: 0 description: An array of steps in the funnel. The order of the steps in the array determines the order of their analysis (that is, the step at index 0 is the first step, the step at index 1 is the second step, and so on). items: type: object properties: title: type: string description: The name of the step action: type: object description: The analyzed event nullable: true required: - name properties: id: type: integer format: int64 deprecated: true nullable: true description: Deprecated parameter. DO NOT use. Has no effect in create/update requests. name: type: string description: Action name of the event. example: page.visit expressions: type: array description: An array of conditions that the event must meet items: type: object description: The `attribute` object is an event attribute that must exist in the analyzed event. The `constraint` object is a condition that the attribute must meet. properties: constraint: description: | This object defines the logic to apply to the `attribute`, and the values to compare it against (if required). **The analytics engine doesn't check if the data types match - you need to ensure that your data types are consistent in the data you send to the database**. discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintEventConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintEventConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintEventConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintEventConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintEventConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintEventConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintEventConstraint" "NULL": "#/components/schemas/analytics-NullConstraintEventConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintEventConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintEventConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintEventConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintEventConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolConstraintType type: string enum: - BOOL description: Tests a boolean value logic: x-class-name: BoolConstraintLogic type: string description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: title: String zero x-class-name: StringZeroConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: x-class-name: StringZeroConstraintLogic type: string description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: x-class-name: StringOneConstraintType type: string enum: - STRING_ONE description: This type is used to test values that are a single string. logic: x-class-name: StringOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: x-class-name: NumberOneConstraintType type: string enum: - NUMBER_ONE description: This type is used to test values that are a single number logic: x-class-name: NumberOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: x-class-name: NumberTwoConstraintType type: string enum: - NUMBER_TWO description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoConstraintLogic type: string enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: x-class-name: StringArrayConstraintType type: string enum: - STRING_ARRAY description: This type is used to check if a string exists in an array defined in `value` logic: type: string x-class-name: StringArrayConstraintLogic description: You can check if the value from `attribute` is in the array defined in `value` enum: - IN - NOT_IN value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: x-class-name: ArrayStringOneConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED description: "`value` should be an array" logic: x-class-name: ArrayStringOneConstraintLogic type: string description: | - CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullConstraintType description: This type is used to check if a value is null type: string enum: - "NULL" logic: x-class-name: NullConstraintLogic type: string description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: x-class-name: DateZeroConstraintType type: string enum: - DATE_ZERO description: Compare a date from `attribute` to the current date logic: x-class-name: LogicZeroConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR description: Logic to apply to the date from `attribute` required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: x-class-name: DateOneConstraintLogic type: string description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: x-class-name: DateTwoConstraintLogic type: string description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - description: This type is used to check if a date matches a date filter. type: object title: Date filter properties: type: x-class-name: DateFilterConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: x-class-name: DateFilterConstraintLogic type: string enum: - DATE_FILTER description: Checks if the date from `attribute` matches a date filter. value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - constrain - attribute required: - action - title - expressions exact: type: boolean default: false description: | When true, the profile's events must be exactly as in the funnel. For example, if the profile's history has events `A -> B -> C -> D`, and the funnel is `A -> C -> D`, the match is not exact, because there is an event between A and C. required: - title - steps required: - type - funnel - type: object properties: type: description: Logical operator between expressions x-class-name: OperatorFilterBoxType type: string enum: - OPERATOR name: type: string description: Name of the resource logic: x-class-name: FilterBoxOperatorType type: string enum: - OR - AND - LEFT_BRACKET - RIGHT_BRACKET required: - type - name - logic expression: deprecated: true example: type: EMPTY discriminator: propertyName: type mapping: FUNCTION: "#/components/schemas/analytics-FilterExpressionFunction" ATTRIBUTE: "#/components/schemas/analytics-AttributeFilterExpressionContent" FUNNEL: "#/components/schemas/analytics-FunnelFilterExpressionContent" EXPRESSION: "#/components/schemas/analytics-ExpressionFilterExpressionContent" EMPTY: "#/components/schemas/analytics-EmptyFilterExpressionContent" oneOf: - type: object description: Logical operators properties: type: description: Logical operators x-class-name: FunctionFilterExpressionContentType type: string enum: - FUNCTION function: x-class-name: FilterFunctionType type: string enum: - AND - OR - BRACKET arg: type: object description: An argument of the function. This is a recursive schema; an argument can be a function which contains more functions in its arguments. x-codegen-schema: FilterExpressionContent arg1: type: object description: An argument of the function. This is a recursive schema; an argument can be a function which contains more functions in its arguments. x-codegen-schema: FilterExpressionContent arg2: type: object description: An argument of the function. This is a recursive schema; an argument can be a function which contains more functions in its arguments. x-codegen-schema: FilterExpressionContent name: type: string required: - type - function - type: object title: Profile attribute properties: type: x-class-name: AttributeFilterExpressionContentType type: string enum: - ATTRIBUTE description: Tests a profile attribute against a condition matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true attribute: type: object description: The condition to test a profile attribute properties: expressions: type: array description: An array of conditions. All conditions must be met. items: type: object properties: constraint: discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintClientConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintClientConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintClientConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintClientConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintClientConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintClientConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintClientConstraint" "NULL": "#/components/schemas/analytics-NullConstraintClientConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintClientConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintClientConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintClientConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintClientConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolClientConstraintType type: string enum: - BOOL description: Tests a boolean value logic: description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. x-class-name: BoolClientConstraintLogic type: string enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: x-class-name: StringZeroClientConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. x-class-name: StringZeroClientConstraintLogic type: string enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: description: This type is used to test values that are a single string. x-class-name: StringOneClientConstraintType type: string enum: - STRING_ONE logic: description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". x-class-name: StringOneClientConstraintLogic type: string enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: description: This type is used to test values that are a single number x-class-name: NumberOneClientConstraintType type: string enum: - NUMBER_ONE logic: description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. x-class-name: NumberOneClientConstraintLogic type: string enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. x-class-name: NumberTwoClientConstraintType type: string enum: - NUMBER_TWO logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoClientConstraintLogic type: string enum: - BETWEEN value1: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue value2: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: description: This type is used to check if a string exists in an array defined in `value` x-class-name: StringArrayClientConstraintType type: string enum: - STRING_ARRAY logic: description: You can check if the value from `attribute` is in the array defined in `value` x-class-name: StringArrayClientConstraintLogic type: string enum: - IN - NOT_IN value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: description: "`value` should be an array" x-class-name: ArrayStringOneClientConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED logic: description: "- CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` " x-class-name: ArrayStringOneClientConstraintLogic type: string enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullClientConstraintType type: string enum: - "NULL" description: This type is used to check if a value is null logic: description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. x-class-name: NullClientConstraintLogic type: string enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: description: Compare a date from `attribute` to the current date x-class-name: DateZeroClientConstraintType type: string enum: - DATE_ZERO logic: description: Logic to apply to the date from `attribute` x-class-name: DateZeroClientConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneClientConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. x-class-name: DateOneClientConstraintLogic type: string enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoClientConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. x-class-name: DateTwoClientConstraintLogic type: string enum: - BETWEEN value1: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue value2: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Date filter description: This type is used to check if a date matches a date filter. properties: type: x-class-name: DateFilterClientConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: description: Checks if the date from `attribute` matches a date filter. x-class-name: DateFilterClientConstraintLogic type: string enum: - DATE_FILTER value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - expressions - type: object title: Funnel properties: type: description: Tests against a funnel x-class-name: FunnelFilterExpressionContentType type: string enum: - FUNNEL matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true funnel: type: object description: Funnel conditions properties: title: type: string description: Title of the funnel. completedWithin: type: object description: | Time constraint for completing all the steps in the funnel. Timer starts when the first step is triggered. - `period` sets the time unit - `value` sets the number of time units properties: period: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: description: The number of time units type: number format: int64 dateFilter: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type steps: type: array minItems: 0 description: An array of steps in the funnel. The order of the steps in the array determines the order of their analysis (that is, the step at index 0 is the first step, the step at index 1 is the second step, and so on). items: type: object properties: title: type: string description: The name of the step action: type: object description: The analyzed event nullable: true required: - name properties: id: type: integer format: int64 deprecated: true nullable: true description: Deprecated parameter. DO NOT use. Has no effect in create/update requests. name: type: string description: Action name of the event. example: page.visit expressions: type: array description: An array of conditions that the event must meet items: type: object description: The `attribute` object is an event attribute that must exist in the analyzed event. The `constraint` object is a condition that the attribute must meet. properties: constraint: description: | This object defines the logic to apply to the `attribute`, and the values to compare it against (if required). **The analytics engine doesn't check if the data types match - you need to ensure that your data types are consistent in the data you send to the database**. discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintEventConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintEventConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintEventConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintEventConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintEventConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintEventConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintEventConstraint" "NULL": "#/components/schemas/analytics-NullConstraintEventConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintEventConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintEventConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintEventConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintEventConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolConstraintType type: string enum: - BOOL description: Tests a boolean value logic: x-class-name: BoolConstraintLogic type: string description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: title: String zero x-class-name: StringZeroConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: x-class-name: StringZeroConstraintLogic type: string description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: x-class-name: StringOneConstraintType type: string enum: - STRING_ONE description: This type is used to test values that are a single string. logic: x-class-name: StringOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: x-class-name: NumberOneConstraintType type: string enum: - NUMBER_ONE description: This type is used to test values that are a single number logic: x-class-name: NumberOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: x-class-name: NumberTwoConstraintType type: string enum: - NUMBER_TWO description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoConstraintLogic type: string enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: x-class-name: StringArrayConstraintType type: string enum: - STRING_ARRAY description: This type is used to check if a string exists in an array defined in `value` logic: type: string x-class-name: StringArrayConstraintLogic description: You can check if the value from `attribute` is in the array defined in `value` enum: - IN - NOT_IN value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: x-class-name: ArrayStringOneConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED description: "`value` should be an array" logic: x-class-name: ArrayStringOneConstraintLogic type: string description: | - CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullConstraintType description: This type is used to check if a value is null type: string enum: - "NULL" logic: x-class-name: NullConstraintLogic type: string description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: x-class-name: DateZeroConstraintType type: string enum: - DATE_ZERO description: Compare a date from `attribute` to the current date logic: x-class-name: LogicZeroConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR description: Logic to apply to the date from `attribute` required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: x-class-name: DateOneConstraintLogic type: string description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: x-class-name: DateTwoConstraintLogic type: string description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - description: This type is used to check if a date matches a date filter. type: object title: Date filter properties: type: x-class-name: DateFilterConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: x-class-name: DateFilterConstraintLogic type: string enum: - DATE_FILTER description: Checks if the date from `attribute` matches a date filter. value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - constrain - attribute required: - action - title - expressions exact: type: boolean default: false description: | When true, the profile's events must be exactly as in the funnel. For example, if the profile's history has events `A -> B -> C -> D`, and the funnel is `A -> C -> D`, the match is not exact, because there is an event between A and C. required: - title - steps - description: Definition of a profile filter type: object properties: type: x-class-name: ExpressionFilterExpressionContentType type: string enum: - EXPRESSION name: type: string matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true expressions: description: Profile filter details. The expressions are applied according to their position in the array. The logical AND/OR operator must be placed between expressions. An empty array means no filters are applied. type: array items: discriminator: propertyName: type mapping: ATTRIBUTE: "#/components/schemas/analytics-AttributeFilterBox" EXPRESSION: "#/components/schemas/analytics-ExpressionFilterBox" FUNNEL: "#/components/schemas/analytics-FunnelFilterBox" OPERATOR: "#/components/schemas/analytics-OperatorFilterBox" oneOf: - type: object properties: type: x-class-name: AttributeFilterBoxType type: string enum: - ATTRIBUTE description: Tests a profile attribute against a condition name: type: string description: Name of the resource matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true attribute: type: object description: The condition to test a profile attribute properties: expressions: type: array description: An array of conditions. All conditions must be met. items: type: object properties: constraint: discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintClientConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintClientConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintClientConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintClientConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintClientConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintClientConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintClientConstraint" "NULL": "#/components/schemas/analytics-NullConstraintClientConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintClientConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintClientConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintClientConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintClientConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolClientConstraintType type: string enum: - BOOL description: Tests a boolean value logic: description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. x-class-name: BoolClientConstraintLogic type: string enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: x-class-name: StringZeroClientConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. x-class-name: StringZeroClientConstraintLogic type: string enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: description: This type is used to test values that are a single string. x-class-name: StringOneClientConstraintType type: string enum: - STRING_ONE logic: description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". x-class-name: StringOneClientConstraintLogic type: string enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: description: This type is used to test values that are a single number x-class-name: NumberOneClientConstraintType type: string enum: - NUMBER_ONE logic: description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. x-class-name: NumberOneClientConstraintLogic type: string enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. x-class-name: NumberTwoClientConstraintType type: string enum: - NUMBER_TWO logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoClientConstraintLogic type: string enum: - BETWEEN value1: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue value2: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: description: This type is used to check if a string exists in an array defined in `value` x-class-name: StringArrayClientConstraintType type: string enum: - STRING_ARRAY logic: description: You can check if the value from `attribute` is in the array defined in `value` x-class-name: StringArrayClientConstraintLogic type: string enum: - IN - NOT_IN value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: description: "`value` should be an array" x-class-name: ArrayStringOneClientConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED logic: description: "- CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` " x-class-name: ArrayStringOneClientConstraintLogic type: string enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullClientConstraintType type: string enum: - "NULL" description: This type is used to check if a value is null logic: description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. x-class-name: NullClientConstraintLogic type: string enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: description: Compare a date from `attribute` to the current date x-class-name: DateZeroClientConstraintType type: string enum: - DATE_ZERO logic: description: Logic to apply to the date from `attribute` x-class-name: DateZeroClientConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneClientConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. x-class-name: DateOneClientConstraintLogic type: string enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoClientConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. x-class-name: DateTwoClientConstraintLogic type: string enum: - BETWEEN value1: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue value2: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Date filter description: This type is used to check if a date matches a date filter. properties: type: x-class-name: DateFilterClientConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: description: Checks if the date from `attribute` matches a date filter. x-class-name: DateFilterClientConstraintLogic type: string enum: - DATE_FILTER value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - expressions - description: A condition to test type: object properties: type: description: A condition to test x-class-name: ExpressionFilterBoxType type: string enum: - EXPRESSION name: type: string matching: type: boolean expressions: $ref: "#/components/schemas/analytics-FilterBox" required: - type - expressions - type: object properties: type: description: Tests against a funnel x-class-name: ExpressionFilterBoxType type: string enum: - FUNNEL name: type: string description: Name of the resource matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true funnel: type: object description: Funnel conditions properties: title: type: string description: Title of the funnel. completedWithin: type: object description: | Time constraint for completing all the steps in the funnel. Timer starts when the first step is triggered. - `period` sets the time unit - `value` sets the number of time units properties: period: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: description: The number of time units type: number format: int64 dateFilter: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type steps: type: array minItems: 0 description: An array of steps in the funnel. The order of the steps in the array determines the order of their analysis (that is, the step at index 0 is the first step, the step at index 1 is the second step, and so on). items: type: object properties: title: type: string description: The name of the step action: type: object description: The analyzed event nullable: true required: - name properties: id: type: integer format: int64 deprecated: true nullable: true description: Deprecated parameter. DO NOT use. Has no effect in create/update requests. name: type: string description: Action name of the event. example: page.visit expressions: type: array description: An array of conditions that the event must meet items: type: object description: The `attribute` object is an event attribute that must exist in the analyzed event. The `constraint` object is a condition that the attribute must meet. properties: constraint: description: | This object defines the logic to apply to the `attribute`, and the values to compare it against (if required). **The analytics engine doesn't check if the data types match - you need to ensure that your data types are consistent in the data you send to the database**. discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintEventConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintEventConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintEventConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintEventConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintEventConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintEventConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintEventConstraint" "NULL": "#/components/schemas/analytics-NullConstraintEventConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintEventConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintEventConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintEventConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintEventConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolConstraintType type: string enum: - BOOL description: Tests a boolean value logic: x-class-name: BoolConstraintLogic type: string description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: title: String zero x-class-name: StringZeroConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: x-class-name: StringZeroConstraintLogic type: string description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: x-class-name: StringOneConstraintType type: string enum: - STRING_ONE description: This type is used to test values that are a single string. logic: x-class-name: StringOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: x-class-name: NumberOneConstraintType type: string enum: - NUMBER_ONE description: This type is used to test values that are a single number logic: x-class-name: NumberOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: x-class-name: NumberTwoConstraintType type: string enum: - NUMBER_TWO description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoConstraintLogic type: string enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: x-class-name: StringArrayConstraintType type: string enum: - STRING_ARRAY description: This type is used to check if a string exists in an array defined in `value` logic: type: string x-class-name: StringArrayConstraintLogic description: You can check if the value from `attribute` is in the array defined in `value` enum: - IN - NOT_IN value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: x-class-name: ArrayStringOneConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED description: "`value` should be an array" logic: x-class-name: ArrayStringOneConstraintLogic type: string description: | - CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullConstraintType description: This type is used to check if a value is null type: string enum: - "NULL" logic: x-class-name: NullConstraintLogic type: string description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: x-class-name: DateZeroConstraintType type: string enum: - DATE_ZERO description: Compare a date from `attribute` to the current date logic: x-class-name: LogicZeroConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR description: Logic to apply to the date from `attribute` required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: x-class-name: DateOneConstraintLogic type: string description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: x-class-name: DateTwoConstraintLogic type: string description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - description: This type is used to check if a date matches a date filter. type: object title: Date filter properties: type: x-class-name: DateFilterConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: x-class-name: DateFilterConstraintLogic type: string enum: - DATE_FILTER description: Checks if the date from `attribute` matches a date filter. value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - constrain - attribute required: - action - title - expressions exact: type: boolean default: false description: | When true, the profile's events must be exactly as in the funnel. For example, if the profile's history has events `A -> B -> C -> D`, and the funnel is `A -> C -> D`, the match is not exact, because there is an event between A and C. required: - title - steps required: - type - funnel - type: object properties: type: description: Logical operator between expressions x-class-name: OperatorFilterBoxType type: string enum: - OPERATOR name: type: string description: Name of the resource logic: x-class-name: FilterBoxOperatorType type: string enum: - OR - AND - LEFT_BRACKET - RIGHT_BRACKET required: - type - name - logic expression: $ref: "#/components/schemas/analytics-FilterExpressionContent" required: - type - expressions - description: An empty value type: object properties: type: description: An empty value x-class-name: EmptyFilterExpressionContentType type: string enum: - EMPTY name: type: string required: - type groupBy: type: array items: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - matching - expressions - expression required: - title - description - filter unique: type: boolean description: When `true`, a profile is only included in the first segment that it matches; segments that follow do not include this profile in their results even if their conditions are met. The segments are checked according to their order in the request. default: true required: - title - segments required: - id - analyticType - analysis - type: object x-class-name: InlineAggregate x-interface-name-ts: InlineAggregate properties: id: type: string format: uuid description: Unique ID of the resource analyticType: type: string enum: - AGGREGATE analysis: description: | Definition of the aggregate. In `attribute`, define the attribute that you want to analyze. discriminator: propertyName: aggregateType mapping: AGGREGATE: "#/components/schemas/analytics-ClientAggregate" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregate" oneOf: - type: object description: The definition of an aggregate properties: aggregateType: x-class-name: ClientAggregateAggregateType type: string description: An aggregate with a profile context enum: - AGGREGATE id: type: integer format: int64 minimum: 0 description: Unique numeric ID of the analysis name: type: string description: Name of the resource description: type: string description: Description of the resource uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c type: type: string description: | The type of calculation. - COUNT allows you to count the total number of the entities that meet the filters. - COUNT_DISTINCT allows you to count the total number of distinct (unique) attribute values in entities which match the filters. - SUM, MIN, MAX, MEDIAN, QUANTILE (requires `level`) and AVG allow you to perform calculations on numerical-value parameters within the entities that meet the filters. - EXISTS checks the existence of at least a single entity that meets the filters and returns 1 when "true" or 0 when "false". - LAST and LAST_MULTI (requires `size`) retrieve the newest matching data. - FIRST and FIRST_MULTI (requires `size`) retrieve the oldest matching data. - LAST_TIME and FIRST_TIME (running aggregates only; require `timeWindow`) retrieve the single newest / oldest matching value from events within the time window preceding the currently evaluated event. - LAST_MULTI_TIME and FIRST_MULTI_TIME (running aggregates only; require `size` and `timeWindow`) retrieve the newest / oldest matching data from events within the time window preceding the currently evaluated event. enum: - AVG - SUM - MIN - MAX - COUNT - MEDIAN - QUANTILE - COUNT_DISTINCT - LAST - FIRST - EXISTS - FIRST_MULTI - LAST_MULTI - FIRST_TIME - LAST_TIME - FIRST_MULTI_TIME - LAST_MULTI_TIME - TOP - BOTTOM - TOP_MULTI - BOTTOM_MULTI level: type: number format: double nullable: true description: Only applies when `type` is `QUANTILE`. This is the percentile whose value will be the result of the analysis. For example, `0.35` is the 35th percentile. size: type: integer format: int32 minimum: 0 description: Only applies and is required when `type` is *_MULTI. Defines how many results to return. unique: type: boolean description: Only applies when `type`` is *_MULTI. When set to `true``, only unique occurrences of an event parameter are included in the results. dateFilter: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type expressions: type: array description: An array of conditions that the event must meet items: type: object description: The `attribute` object is an event attribute that must exist in the analyzed event. The `constraint` object is a condition that the attribute must meet. properties: constraint: description: | This object defines the logic to apply to the `attribute`, and the values to compare it against (if required). **The analytics engine doesn't check if the data types match - you need to ensure that your data types are consistent in the data you send to the database**. discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintEventConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintEventConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintEventConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintEventConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintEventConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintEventConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintEventConstraint" "NULL": "#/components/schemas/analytics-NullConstraintEventConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintEventConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintEventConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintEventConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintEventConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolConstraintType type: string enum: - BOOL description: Tests a boolean value logic: x-class-name: BoolConstraintLogic type: string description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: title: String zero x-class-name: StringZeroConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: x-class-name: StringZeroConstraintLogic type: string description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: x-class-name: StringOneConstraintType type: string enum: - STRING_ONE description: This type is used to test values that are a single string. logic: x-class-name: StringOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: x-class-name: NumberOneConstraintType type: string enum: - NUMBER_ONE description: This type is used to test values that are a single number logic: x-class-name: NumberOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: x-class-name: NumberTwoConstraintType type: string enum: - NUMBER_TWO description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoConstraintLogic type: string enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: x-class-name: StringArrayConstraintType type: string enum: - STRING_ARRAY description: This type is used to check if a string exists in an array defined in `value` logic: type: string x-class-name: StringArrayConstraintLogic description: You can check if the value from `attribute` is in the array defined in `value` enum: - IN - NOT_IN value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: x-class-name: ArrayStringOneConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED description: "`value` should be an array" logic: x-class-name: ArrayStringOneConstraintLogic type: string description: | - CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullConstraintType description: This type is used to check if a value is null type: string enum: - "NULL" logic: x-class-name: NullConstraintLogic type: string description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: x-class-name: DateZeroConstraintType type: string enum: - DATE_ZERO description: Compare a date from `attribute` to the current date logic: x-class-name: LogicZeroConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR description: Logic to apply to the date from `attribute` required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: x-class-name: DateOneConstraintLogic type: string description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: x-class-name: DateTwoConstraintLogic type: string description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - description: This type is used to check if a date matches a date filter. type: object title: Date filter properties: type: x-class-name: DateFilterConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: x-class-name: DateFilterConstraintLogic type: string enum: - DATE_FILTER description: Checks if the date from `attribute` matches a date filter. value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - constrain - attribute attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type action: type: object description: The analyzed event nullable: true required: - name properties: id: type: integer format: int64 deprecated: true nullable: true description: Deprecated parameter. DO NOT use. Has no effect in create/update requests. name: type: string description: Action name of the event. example: page.visit required: - aggregateType - id - name - description - uuid - type - level - size - unique - dateFilter - expressions - attribute - action - type: object properties: aggregateType: description: An aggregate with an event context x-class-name: RunningAggregateAggregateType type: string enum: - RUNNING_AGGREGATE id: type: integer format: int64 minimum: 0 description: Unique numeric ID of the analysis name: type: string description: Name of the resource description: type: string description: Description of the resource uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c type: type: string description: | The type of calculation. - COUNT allows you to count the total number of the entities that meet the filters. - COUNT_DISTINCT allows you to count the total number of distinct (unique) attribute values in entities which match the filters. - SUM, MIN, MAX, MEDIAN, QUANTILE (requires `level`) and AVG allow you to perform calculations on numerical-value parameters within the entities that meet the filters. - EXISTS checks the existence of at least a single entity that meets the filters and returns 1 when "true" or 0 when "false". - LAST and LAST_MULTI (requires `size`) retrieve the newest matching data. - FIRST and FIRST_MULTI (requires `size`) retrieve the oldest matching data. - LAST_TIME and FIRST_TIME (running aggregates only; require `timeWindow`) retrieve the single newest / oldest matching value from events within the time window preceding the currently evaluated event. - LAST_MULTI_TIME and FIRST_MULTI_TIME (running aggregates only; require `size` and `timeWindow`) retrieve the newest / oldest matching data from events within the time window preceding the currently evaluated event. enum: - AVG - SUM - MIN - MAX - COUNT - MEDIAN - QUANTILE - COUNT_DISTINCT - LAST - FIRST - EXISTS - FIRST_MULTI - LAST_MULTI - FIRST_TIME - LAST_TIME - FIRST_MULTI_TIME - LAST_MULTI_TIME - TOP - BOTTOM - TOP_MULTI - BOTTOM_MULTI level: type: number format: double nullable: true description: Only applies when `type` is `QUANTILE`. This is the percentile whose value will be the result of the analysis. For example, `0.35` is the 35th percentile. size: type: integer format: int32 minimum: 0 description: Only applies and is required when `type` is *_MULTI. Defines how many results to return. unique: type: boolean description: Only applies when `type`` is *_MULTI. When set to `true``, only unique occurrences of an event parameter are included in the results. dateFilter: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type expressions: type: array description: An array of conditions that the event must meet items: type: object description: The `attribute` object is an event attribute that must exist in the analyzed event. The `constraint` object is a condition that the attribute must meet. properties: constraint: description: | This object defines the logic to apply to the `attribute`, and the values to compare it against (if required). **The analytics engine doesn't check if the data types match - you need to ensure that your data types are consistent in the data you send to the database**. discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintEventConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintEventConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintEventConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintEventConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintEventConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintEventConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintEventConstraint" "NULL": "#/components/schemas/analytics-NullConstraintEventConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintEventConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintEventConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintEventConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintEventConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolConstraintType type: string enum: - BOOL description: Tests a boolean value logic: x-class-name: BoolConstraintLogic type: string description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: title: String zero x-class-name: StringZeroConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: x-class-name: StringZeroConstraintLogic type: string description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: x-class-name: StringOneConstraintType type: string enum: - STRING_ONE description: This type is used to test values that are a single string. logic: x-class-name: StringOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: x-class-name: NumberOneConstraintType type: string enum: - NUMBER_ONE description: This type is used to test values that are a single number logic: x-class-name: NumberOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: x-class-name: NumberTwoConstraintType type: string enum: - NUMBER_TWO description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoConstraintLogic type: string enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: x-class-name: StringArrayConstraintType type: string enum: - STRING_ARRAY description: This type is used to check if a string exists in an array defined in `value` logic: type: string x-class-name: StringArrayConstraintLogic description: You can check if the value from `attribute` is in the array defined in `value` enum: - IN - NOT_IN value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: x-class-name: ArrayStringOneConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED description: "`value` should be an array" logic: x-class-name: ArrayStringOneConstraintLogic type: string description: | - CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullConstraintType description: This type is used to check if a value is null type: string enum: - "NULL" logic: x-class-name: NullConstraintLogic type: string description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: x-class-name: DateZeroConstraintType type: string enum: - DATE_ZERO description: Compare a date from `attribute` to the current date logic: x-class-name: LogicZeroConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR description: Logic to apply to the date from `attribute` required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: x-class-name: DateOneConstraintLogic type: string description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: x-class-name: DateTwoConstraintLogic type: string description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - description: This type is used to check if a date matches a date filter. type: object title: Date filter properties: type: x-class-name: DateFilterConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: x-class-name: DateFilterConstraintLogic type: string enum: - DATE_FILTER description: Checks if the date from `attribute` matches a date filter. value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - constrain - attribute attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type action: type: object description: The analyzed event nullable: true required: - name properties: id: type: integer format: int64 deprecated: true nullable: true description: Deprecated parameter. DO NOT use. Has no effect in create/update requests. name: type: string description: Action name of the event. example: page.visit excludeCurrent: type: boolean description: When `false`, data from the event that is the subject of the analysis is analyzed in addition to data of the events that occurred before it. timeWindow: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value required: - aggregateType - id - name - description - uuid - type - level - size - unique - dateFilter - expressions - attribute - action - excludeCurrent required: - id - analyticType - analysis - type: object x-class-name: InlineRunningAggregate x-interface-name-ts: InlineRunningAggregate properties: id: type: string format: uuid description: Unique ID of the resource analyticType: type: string enum: - RUNNING_AGGREGATE analysis: description: | Definition of the aggregate. In `attribute`, define the attribute that you want to analyze. discriminator: propertyName: aggregateType mapping: AGGREGATE: "#/components/schemas/analytics-ClientAggregate" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregate" oneOf: - type: object description: The definition of an aggregate properties: aggregateType: x-class-name: ClientAggregateAggregateType type: string description: An aggregate with a profile context enum: - AGGREGATE id: type: integer format: int64 minimum: 0 description: Unique numeric ID of the analysis name: type: string description: Name of the resource description: type: string description: Description of the resource uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c type: type: string description: | The type of calculation. - COUNT allows you to count the total number of the entities that meet the filters. - COUNT_DISTINCT allows you to count the total number of distinct (unique) attribute values in entities which match the filters. - SUM, MIN, MAX, MEDIAN, QUANTILE (requires `level`) and AVG allow you to perform calculations on numerical-value parameters within the entities that meet the filters. - EXISTS checks the existence of at least a single entity that meets the filters and returns 1 when "true" or 0 when "false". - LAST and LAST_MULTI (requires `size`) retrieve the newest matching data. - FIRST and FIRST_MULTI (requires `size`) retrieve the oldest matching data. - LAST_TIME and FIRST_TIME (running aggregates only; require `timeWindow`) retrieve the single newest / oldest matching value from events within the time window preceding the currently evaluated event. - LAST_MULTI_TIME and FIRST_MULTI_TIME (running aggregates only; require `size` and `timeWindow`) retrieve the newest / oldest matching data from events within the time window preceding the currently evaluated event. enum: - AVG - SUM - MIN - MAX - COUNT - MEDIAN - QUANTILE - COUNT_DISTINCT - LAST - FIRST - EXISTS - FIRST_MULTI - LAST_MULTI - FIRST_TIME - LAST_TIME - FIRST_MULTI_TIME - LAST_MULTI_TIME - TOP - BOTTOM - TOP_MULTI - BOTTOM_MULTI level: type: number format: double nullable: true description: Only applies when `type` is `QUANTILE`. This is the percentile whose value will be the result of the analysis. For example, `0.35` is the 35th percentile. size: type: integer format: int32 minimum: 0 description: Only applies and is required when `type` is *_MULTI. Defines how many results to return. unique: type: boolean description: Only applies when `type`` is *_MULTI. When set to `true``, only unique occurrences of an event parameter are included in the results. dateFilter: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type expressions: type: array description: An array of conditions that the event must meet items: type: object description: The `attribute` object is an event attribute that must exist in the analyzed event. The `constraint` object is a condition that the attribute must meet. properties: constraint: description: | This object defines the logic to apply to the `attribute`, and the values to compare it against (if required). **The analytics engine doesn't check if the data types match - you need to ensure that your data types are consistent in the data you send to the database**. discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintEventConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintEventConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintEventConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintEventConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintEventConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintEventConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintEventConstraint" "NULL": "#/components/schemas/analytics-NullConstraintEventConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintEventConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintEventConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintEventConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintEventConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolConstraintType type: string enum: - BOOL description: Tests a boolean value logic: x-class-name: BoolConstraintLogic type: string description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: title: String zero x-class-name: StringZeroConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: x-class-name: StringZeroConstraintLogic type: string description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: x-class-name: StringOneConstraintType type: string enum: - STRING_ONE description: This type is used to test values that are a single string. logic: x-class-name: StringOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: x-class-name: NumberOneConstraintType type: string enum: - NUMBER_ONE description: This type is used to test values that are a single number logic: x-class-name: NumberOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: x-class-name: NumberTwoConstraintType type: string enum: - NUMBER_TWO description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoConstraintLogic type: string enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: x-class-name: StringArrayConstraintType type: string enum: - STRING_ARRAY description: This type is used to check if a string exists in an array defined in `value` logic: type: string x-class-name: StringArrayConstraintLogic description: You can check if the value from `attribute` is in the array defined in `value` enum: - IN - NOT_IN value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: x-class-name: ArrayStringOneConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED description: "`value` should be an array" logic: x-class-name: ArrayStringOneConstraintLogic type: string description: | - CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullConstraintType description: This type is used to check if a value is null type: string enum: - "NULL" logic: x-class-name: NullConstraintLogic type: string description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: x-class-name: DateZeroConstraintType type: string enum: - DATE_ZERO description: Compare a date from `attribute` to the current date logic: x-class-name: LogicZeroConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR description: Logic to apply to the date from `attribute` required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: x-class-name: DateOneConstraintLogic type: string description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: x-class-name: DateTwoConstraintLogic type: string description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - description: This type is used to check if a date matches a date filter. type: object title: Date filter properties: type: x-class-name: DateFilterConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: x-class-name: DateFilterConstraintLogic type: string enum: - DATE_FILTER description: Checks if the date from `attribute` matches a date filter. value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - constrain - attribute attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type action: type: object description: The analyzed event nullable: true required: - name properties: id: type: integer format: int64 deprecated: true nullable: true description: Deprecated parameter. DO NOT use. Has no effect in create/update requests. name: type: string description: Action name of the event. example: page.visit required: - aggregateType - id - name - description - uuid - type - level - size - unique - dateFilter - expressions - attribute - action - type: object properties: aggregateType: description: An aggregate with an event context x-class-name: RunningAggregateAggregateType type: string enum: - RUNNING_AGGREGATE id: type: integer format: int64 minimum: 0 description: Unique numeric ID of the analysis name: type: string description: Name of the resource description: type: string description: Description of the resource uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c type: type: string description: | The type of calculation. - COUNT allows you to count the total number of the entities that meet the filters. - COUNT_DISTINCT allows you to count the total number of distinct (unique) attribute values in entities which match the filters. - SUM, MIN, MAX, MEDIAN, QUANTILE (requires `level`) and AVG allow you to perform calculations on numerical-value parameters within the entities that meet the filters. - EXISTS checks the existence of at least a single entity that meets the filters and returns 1 when "true" or 0 when "false". - LAST and LAST_MULTI (requires `size`) retrieve the newest matching data. - FIRST and FIRST_MULTI (requires `size`) retrieve the oldest matching data. - LAST_TIME and FIRST_TIME (running aggregates only; require `timeWindow`) retrieve the single newest / oldest matching value from events within the time window preceding the currently evaluated event. - LAST_MULTI_TIME and FIRST_MULTI_TIME (running aggregates only; require `size` and `timeWindow`) retrieve the newest / oldest matching data from events within the time window preceding the currently evaluated event. enum: - AVG - SUM - MIN - MAX - COUNT - MEDIAN - QUANTILE - COUNT_DISTINCT - LAST - FIRST - EXISTS - FIRST_MULTI - LAST_MULTI - FIRST_TIME - LAST_TIME - FIRST_MULTI_TIME - LAST_MULTI_TIME - TOP - BOTTOM - TOP_MULTI - BOTTOM_MULTI level: type: number format: double nullable: true description: Only applies when `type` is `QUANTILE`. This is the percentile whose value will be the result of the analysis. For example, `0.35` is the 35th percentile. size: type: integer format: int32 minimum: 0 description: Only applies and is required when `type` is *_MULTI. Defines how many results to return. unique: type: boolean description: Only applies when `type`` is *_MULTI. When set to `true``, only unique occurrences of an event parameter are included in the results. dateFilter: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type expressions: type: array description: An array of conditions that the event must meet items: type: object description: The `attribute` object is an event attribute that must exist in the analyzed event. The `constraint` object is a condition that the attribute must meet. properties: constraint: description: | This object defines the logic to apply to the `attribute`, and the values to compare it against (if required). **The analytics engine doesn't check if the data types match - you need to ensure that your data types are consistent in the data you send to the database**. discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintEventConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintEventConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintEventConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintEventConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintEventConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintEventConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintEventConstraint" "NULL": "#/components/schemas/analytics-NullConstraintEventConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintEventConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintEventConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintEventConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintEventConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolConstraintType type: string enum: - BOOL description: Tests a boolean value logic: x-class-name: BoolConstraintLogic type: string description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: title: String zero x-class-name: StringZeroConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: x-class-name: StringZeroConstraintLogic type: string description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: x-class-name: StringOneConstraintType type: string enum: - STRING_ONE description: This type is used to test values that are a single string. logic: x-class-name: StringOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: x-class-name: NumberOneConstraintType type: string enum: - NUMBER_ONE description: This type is used to test values that are a single number logic: x-class-name: NumberOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: x-class-name: NumberTwoConstraintType type: string enum: - NUMBER_TWO description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoConstraintLogic type: string enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: x-class-name: StringArrayConstraintType type: string enum: - STRING_ARRAY description: This type is used to check if a string exists in an array defined in `value` logic: type: string x-class-name: StringArrayConstraintLogic description: You can check if the value from `attribute` is in the array defined in `value` enum: - IN - NOT_IN value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: x-class-name: ArrayStringOneConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED description: "`value` should be an array" logic: x-class-name: ArrayStringOneConstraintLogic type: string description: | - CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullConstraintType description: This type is used to check if a value is null type: string enum: - "NULL" logic: x-class-name: NullConstraintLogic type: string description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: x-class-name: DateZeroConstraintType type: string enum: - DATE_ZERO description: Compare a date from `attribute` to the current date logic: x-class-name: LogicZeroConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR description: Logic to apply to the date from `attribute` required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: x-class-name: DateOneConstraintLogic type: string description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: x-class-name: DateTwoConstraintLogic type: string description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - description: This type is used to check if a date matches a date filter. type: object title: Date filter properties: type: x-class-name: DateFilterConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: x-class-name: DateFilterConstraintLogic type: string enum: - DATE_FILTER description: Checks if the date from `attribute` matches a date filter. value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - constrain - attribute attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type action: type: object description: The analyzed event nullable: true required: - name properties: id: type: integer format: int64 deprecated: true nullable: true description: Deprecated parameter. DO NOT use. Has no effect in create/update requests. name: type: string description: Action name of the event. example: page.visit excludeCurrent: type: boolean description: When `false`, data from the event that is the subject of the analysis is analyzed in addition to data of the events that occurred before it. timeWindow: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value required: - aggregateType - id - name - description - uuid - type - level - size - unique - dateFilter - expressions - attribute - action - excludeCurrent required: - id - analyticType - analysis - type: object x-class-name: InlineMetric x-interface-name-ts: InlineMetric properties: id: type: string format: uuid description: Unique ID of the resource analyticType: type: string enum: - METRIC analysis: type: object description: Structure of the analytical query properties: id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c title: type: string description: Name of the resource description: type: string description: Description of the resource format: type: object description: | This object defines the display format of the data in the Synerise Web UI. The JSON format of the results is not affected. Values other than in the enums or min-max ranges are accepted by the backend, but may not be displayed properly by the Synerise Web UI. properties: compactNumbers: type: boolean default: false description: When `true`, numbers are shortened. For example, "20500" becomes "20.5k". currency: type: string x-class-name: Currency nullable: true title: CurrencyName enum: - EUR - USD - PLN - JPY description: The currency to use when `dataFormat` is `cash` dataFormat: type: string title: DateFormatName x-class-name: DateFormatName nullable: true enum: - cash - numeric - percent description: Format of the data fixedLength: description: The number of digits after the decimal point type: integer format: int32 default: 0 minimum: 0 maximum: 4 useSeparator: type: boolean default: false description: Enables the use of a comma as the thousands separator. When `false`, no separator is used. comparison: type: object description: Use this filter to compare the data from `expression` with another period. If this is used, then the result of the analysis is the difference between the two periods. properties: dateFilter: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type metricType: type: string x-class-name: MetricType enum: - SIMPLE - FORMULA description: | Defines the type of the metric. This affects the contents of the `expression` object. When the type is `SIMPLE`, the `expression` can only include a single argument. expression: example: type: VALUE value: type: NUMBER value: 100 discriminator: propertyName: type mapping: FUNCTION: "#/components/schemas/analytics-MetricExpressionContentFunction" VALUE: "#/components/schemas/analytics-MetricExpressionContentValue" oneOf: - type: object description: A function to apply x-interface-name-ts: MetricExpressionContentFunction properties: type: type: string enum: - FUNCTION function: x-class-name: MetricExpressionContentFunctionFunction description: | The function to apply. The number of required arguments depends on the function arity: - Nullary (0 args): NOW - Unary (1 arg via `arg`): LN, ABS, CEIL, EXP, FLOOR, ROUND, TO_NUMBER, TO_STRING, DAY_OF_MONTH, DAY_OF_WEEK, DAY_OF_YEAR, HOUR, MONTH, WEEK, YEAR, TO_MONEY, TO_TIMESTAMP, TO_DATE, BRACKET - Binary (2 args via `arg1`, `arg2`): DIVIDE, IF_NULL, MAX, MIN, MOD, MULTIPLY, SUB, SUM, GREATER, GREATER_OR_EQUALS, LESS, LESS_OR_EQUAL, NOT_EQUAL, EQUALS, ADD_YEARS, CONCAT, REGEXP - Ternary (3 args via `arg1`, `arg2`, `arg3`): IF (arg1 - condition; arg2 - return if true; arg3 - return if false) type: string enum: - NOW - LN - ABS - CEIL - EXP - FLOOR - ROUND - BRACKET - TO_NUMBER - TO_STRING - DAY_OF_MONTH - DAY_OF_WEEK - DAY_OF_YEAR - HOUR - MONTH - WEEK - YEAR - TO_MONEY - TO_TIMESTAMP - TO_DATE - DIVIDE - IFNULL - MAX - MIN - MOD - MULTIPLY - SUB - SUM - GREATER - GREATER_OR_EQUALS - LESS - LESS_OR_EQUALS - NOT_EQUALS - EQUALS - ADD_YEARS - CONCAT - REGEXP - IF arg: type: object description: An argument of the function. This is a recursive schema; an argument can be a function which contains more functions in its arguments. x-codegen-schema: MetricExpressionContent arg1: type: object description: An argument of the function. This is a recursive schema; an argument can be a function which contains more functions in its arguments. x-codegen-schema: MetricExpressionContent arg2: type: object description: An argument of the function. This is a recursive schema; an argument can be a function which contains more functions in its arguments. x-codegen-schema: MetricExpressionContent arg3: type: object description: An argument of the function. This is a recursive schema; an argument can be a function which contains more functions in its arguments. x-codegen-schema: MetricExpressionContent required: - type - function - type: object description: An expression to calculate properties: type: type: string enum: - VALUE title: type: string description: Name of the resource value: discriminator: propertyName: type mapping: OPERATOR: "#/components/schemas/analytics-OperatorMetricExpression" NUMBER: "#/components/schemas/analytics-NumberMetricExpression" EVENT: "#/components/schemas/analytics-EventMetricExpression" CLIENT: "#/components/schemas/analytics-ClientMetricExpression" METRIC: "#/components/schemas/analytics-NestedMetricExpression" oneOf: - type: object description: Definition of a metric expression x-class-name: ClientMetricExpression x-interface-name-ts: ClientMetricExpression properties: type: type: string enum: - CLIENT title: type: string description: Name of the resource aggregation: type: object properties: type: type: string description: | The type of calculation. - COUNT allows you to count the total number of the entities that meet the filters. - COUNT_DISTINCT allows you to count the total number of distinct (unique) attribute values in entities which match the filters. - SUM, MIN, MAX, MEDIAN, QUANTILE (requires `level`) and AVG allow you to perform calculations on numerical-value parameters within the entities that meet the filters. - EXISTS checks the existence of at least a single entity that meets the filters and returns 1 when "true" or 0 when "false". - LAST and LAST_MULTI (requires `size`) retrieve the newest matching data. - FIRST and FIRST_MULTI (requires `size`) retrieve the oldest matching data. - LAST_TIME and FIRST_TIME (running aggregates only; require `timeWindow`) retrieve the single newest / oldest matching value from events within the time window preceding the currently evaluated event. - LAST_MULTI_TIME and FIRST_MULTI_TIME (running aggregates only; require `size` and `timeWindow`) retrieve the newest / oldest matching data from events within the time window preceding the currently evaluated event. enum: - AVG - SUM - MIN - MAX - COUNT - MEDIAN - QUANTILE - COUNT_DISTINCT - LAST - FIRST - EXISTS - FIRST_MULTI - LAST_MULTI - FIRST_TIME - LAST_TIME - FIRST_MULTI_TIME - LAST_MULTI_TIME - TOP - BOTTOM - TOP_MULTI - BOTTOM_MULTI attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type level: type: number format: double nullable: true description: Only applies when `type` is `QUANTILE`. This is the percentile whose value will be the result of the analysis. For example, `0.35` is the 35th percentile. required: - type - attribute filter: type: object description: | This filter lets you limit the results to profiles that match it. For no filter, leave the object empty. The `expression` object is only used by the Synerise Web Portal. If you're integrating an API, don't send this object or send it empty. If you send `expression` and `expressions`, `expressions` takes priority. properties: matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true expressions: type: array description: Profile filter details. The expressions are applied according to their position in the array. The logical AND/OR operator must be placed between expressions. An empty array means no filters are applied. items: discriminator: propertyName: type mapping: ATTRIBUTE: "#/components/schemas/analytics-AttributeFilterBox" EXPRESSION: "#/components/schemas/analytics-ExpressionFilterBox" FUNNEL: "#/components/schemas/analytics-FunnelFilterBox" OPERATOR: "#/components/schemas/analytics-OperatorFilterBox" oneOf: - type: object properties: type: x-class-name: AttributeFilterBoxType type: string enum: - ATTRIBUTE description: Tests a profile attribute against a condition name: type: string description: Name of the resource matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true attribute: type: object description: The condition to test a profile attribute properties: expressions: type: array description: An array of conditions. All conditions must be met. items: type: object properties: constraint: discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintClientConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintClientConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintClientConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintClientConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintClientConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintClientConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintClientConstraint" "NULL": "#/components/schemas/analytics-NullConstraintClientConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintClientConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintClientConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintClientConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintClientConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolClientConstraintType type: string enum: - BOOL description: Tests a boolean value logic: description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. x-class-name: BoolClientConstraintLogic type: string enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: x-class-name: StringZeroClientConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. x-class-name: StringZeroClientConstraintLogic type: string enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: description: This type is used to test values that are a single string. x-class-name: StringOneClientConstraintType type: string enum: - STRING_ONE logic: description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". x-class-name: StringOneClientConstraintLogic type: string enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: description: This type is used to test values that are a single number x-class-name: NumberOneClientConstraintType type: string enum: - NUMBER_ONE logic: description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. x-class-name: NumberOneClientConstraintLogic type: string enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. x-class-name: NumberTwoClientConstraintType type: string enum: - NUMBER_TWO logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoClientConstraintLogic type: string enum: - BETWEEN value1: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue value2: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: description: This type is used to check if a string exists in an array defined in `value` x-class-name: StringArrayClientConstraintType type: string enum: - STRING_ARRAY logic: description: You can check if the value from `attribute` is in the array defined in `value` x-class-name: StringArrayClientConstraintLogic type: string enum: - IN - NOT_IN value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: description: "`value` should be an array" x-class-name: ArrayStringOneClientConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED logic: description: "- CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` " x-class-name: ArrayStringOneClientConstraintLogic type: string enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullClientConstraintType type: string enum: - "NULL" description: This type is used to check if a value is null logic: description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. x-class-name: NullClientConstraintLogic type: string enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: description: Compare a date from `attribute` to the current date x-class-name: DateZeroClientConstraintType type: string enum: - DATE_ZERO logic: description: Logic to apply to the date from `attribute` x-class-name: DateZeroClientConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneClientConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. x-class-name: DateOneClientConstraintLogic type: string enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoClientConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. x-class-name: DateTwoClientConstraintLogic type: string enum: - BETWEEN value1: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue value2: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Date filter description: This type is used to check if a date matches a date filter. properties: type: x-class-name: DateFilterClientConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: description: Checks if the date from `attribute` matches a date filter. x-class-name: DateFilterClientConstraintLogic type: string enum: - DATE_FILTER value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - expressions - description: A condition to test type: object properties: type: description: A condition to test x-class-name: ExpressionFilterBoxType type: string enum: - EXPRESSION name: type: string matching: type: boolean expressions: $ref: "#/components/schemas/analytics-FilterBox" required: - type - expressions - type: object properties: type: description: Tests against a funnel x-class-name: ExpressionFilterBoxType type: string enum: - FUNNEL name: type: string description: Name of the resource matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true funnel: type: object description: Funnel conditions properties: title: type: string description: Title of the funnel. completedWithin: type: object description: | Time constraint for completing all the steps in the funnel. Timer starts when the first step is triggered. - `period` sets the time unit - `value` sets the number of time units properties: period: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: description: The number of time units type: number format: int64 dateFilter: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type steps: type: array minItems: 0 description: An array of steps in the funnel. The order of the steps in the array determines the order of their analysis (that is, the step at index 0 is the first step, the step at index 1 is the second step, and so on). items: type: object properties: title: type: string description: The name of the step action: type: object description: The analyzed event nullable: true required: - name properties: id: type: integer format: int64 deprecated: true nullable: true description: Deprecated parameter. DO NOT use. Has no effect in create/update requests. name: type: string description: Action name of the event. example: page.visit expressions: type: array description: An array of conditions that the event must meet items: type: object description: The `attribute` object is an event attribute that must exist in the analyzed event. The `constraint` object is a condition that the attribute must meet. properties: constraint: description: | This object defines the logic to apply to the `attribute`, and the values to compare it against (if required). **The analytics engine doesn't check if the data types match - you need to ensure that your data types are consistent in the data you send to the database**. discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintEventConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintEventConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintEventConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintEventConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintEventConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintEventConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintEventConstraint" "NULL": "#/components/schemas/analytics-NullConstraintEventConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintEventConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintEventConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintEventConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintEventConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolConstraintType type: string enum: - BOOL description: Tests a boolean value logic: x-class-name: BoolConstraintLogic type: string description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: title: String zero x-class-name: StringZeroConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: x-class-name: StringZeroConstraintLogic type: string description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: x-class-name: StringOneConstraintType type: string enum: - STRING_ONE description: This type is used to test values that are a single string. logic: x-class-name: StringOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: x-class-name: NumberOneConstraintType type: string enum: - NUMBER_ONE description: This type is used to test values that are a single number logic: x-class-name: NumberOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: x-class-name: NumberTwoConstraintType type: string enum: - NUMBER_TWO description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoConstraintLogic type: string enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: x-class-name: StringArrayConstraintType type: string enum: - STRING_ARRAY description: This type is used to check if a string exists in an array defined in `value` logic: type: string x-class-name: StringArrayConstraintLogic description: You can check if the value from `attribute` is in the array defined in `value` enum: - IN - NOT_IN value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: x-class-name: ArrayStringOneConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED description: "`value` should be an array" logic: x-class-name: ArrayStringOneConstraintLogic type: string description: | - CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullConstraintType description: This type is used to check if a value is null type: string enum: - "NULL" logic: x-class-name: NullConstraintLogic type: string description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: x-class-name: DateZeroConstraintType type: string enum: - DATE_ZERO description: Compare a date from `attribute` to the current date logic: x-class-name: LogicZeroConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR description: Logic to apply to the date from `attribute` required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: x-class-name: DateOneConstraintLogic type: string description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: x-class-name: DateTwoConstraintLogic type: string description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - description: This type is used to check if a date matches a date filter. type: object title: Date filter properties: type: x-class-name: DateFilterConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: x-class-name: DateFilterConstraintLogic type: string enum: - DATE_FILTER description: Checks if the date from `attribute` matches a date filter. value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - constrain - attribute required: - action - title - expressions exact: type: boolean default: false description: | When true, the profile's events must be exactly as in the funnel. For example, if the profile's history has events `A -> B -> C -> D`, and the funnel is `A -> C -> D`, the match is not exact, because there is an event between A and C. required: - title - steps required: - type - funnel - type: object properties: type: description: Logical operator between expressions x-class-name: OperatorFilterBoxType type: string enum: - OPERATOR name: type: string description: Name of the resource logic: x-class-name: FilterBoxOperatorType type: string enum: - OR - AND - LEFT_BRACKET - RIGHT_BRACKET required: - type - name - logic expression: deprecated: true example: type: EMPTY discriminator: propertyName: type mapping: FUNCTION: "#/components/schemas/analytics-FilterExpressionFunction" ATTRIBUTE: "#/components/schemas/analytics-AttributeFilterExpressionContent" FUNNEL: "#/components/schemas/analytics-FunnelFilterExpressionContent" EXPRESSION: "#/components/schemas/analytics-ExpressionFilterExpressionContent" EMPTY: "#/components/schemas/analytics-EmptyFilterExpressionContent" oneOf: - type: object description: Logical operators properties: type: description: Logical operators x-class-name: FunctionFilterExpressionContentType type: string enum: - FUNCTION function: x-class-name: FilterFunctionType type: string enum: - AND - OR - BRACKET arg: type: object description: An argument of the function. This is a recursive schema; an argument can be a function which contains more functions in its arguments. x-codegen-schema: FilterExpressionContent arg1: type: object description: An argument of the function. This is a recursive schema; an argument can be a function which contains more functions in its arguments. x-codegen-schema: FilterExpressionContent arg2: type: object description: An argument of the function. This is a recursive schema; an argument can be a function which contains more functions in its arguments. x-codegen-schema: FilterExpressionContent name: type: string required: - type - function - type: object title: Profile attribute properties: type: x-class-name: AttributeFilterExpressionContentType type: string enum: - ATTRIBUTE description: Tests a profile attribute against a condition matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true attribute: type: object description: The condition to test a profile attribute properties: expressions: type: array description: An array of conditions. All conditions must be met. items: type: object properties: constraint: discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintClientConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintClientConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintClientConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintClientConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintClientConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintClientConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintClientConstraint" "NULL": "#/components/schemas/analytics-NullConstraintClientConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintClientConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintClientConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintClientConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintClientConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolClientConstraintType type: string enum: - BOOL description: Tests a boolean value logic: description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. x-class-name: BoolClientConstraintLogic type: string enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: x-class-name: StringZeroClientConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. x-class-name: StringZeroClientConstraintLogic type: string enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: description: This type is used to test values that are a single string. x-class-name: StringOneClientConstraintType type: string enum: - STRING_ONE logic: description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". x-class-name: StringOneClientConstraintLogic type: string enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: description: This type is used to test values that are a single number x-class-name: NumberOneClientConstraintType type: string enum: - NUMBER_ONE logic: description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. x-class-name: NumberOneClientConstraintLogic type: string enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. x-class-name: NumberTwoClientConstraintType type: string enum: - NUMBER_TWO logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoClientConstraintLogic type: string enum: - BETWEEN value1: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue value2: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: description: This type is used to check if a string exists in an array defined in `value` x-class-name: StringArrayClientConstraintType type: string enum: - STRING_ARRAY logic: description: You can check if the value from `attribute` is in the array defined in `value` x-class-name: StringArrayClientConstraintLogic type: string enum: - IN - NOT_IN value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: description: "`value` should be an array" x-class-name: ArrayStringOneClientConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED logic: description: "- CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` " x-class-name: ArrayStringOneClientConstraintLogic type: string enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullClientConstraintType type: string enum: - "NULL" description: This type is used to check if a value is null logic: description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. x-class-name: NullClientConstraintLogic type: string enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: description: Compare a date from `attribute` to the current date x-class-name: DateZeroClientConstraintType type: string enum: - DATE_ZERO logic: description: Logic to apply to the date from `attribute` x-class-name: DateZeroClientConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneClientConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. x-class-name: DateOneClientConstraintLogic type: string enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoClientConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. x-class-name: DateTwoClientConstraintLogic type: string enum: - BETWEEN value1: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue value2: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Date filter description: This type is used to check if a date matches a date filter. properties: type: x-class-name: DateFilterClientConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: description: Checks if the date from `attribute` matches a date filter. x-class-name: DateFilterClientConstraintLogic type: string enum: - DATE_FILTER value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - expressions - type: object title: Funnel properties: type: description: Tests against a funnel x-class-name: FunnelFilterExpressionContentType type: string enum: - FUNNEL matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true funnel: type: object description: Funnel conditions properties: title: type: string description: Title of the funnel. completedWithin: type: object description: | Time constraint for completing all the steps in the funnel. Timer starts when the first step is triggered. - `period` sets the time unit - `value` sets the number of time units properties: period: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: description: The number of time units type: number format: int64 dateFilter: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type steps: type: array minItems: 0 description: An array of steps in the funnel. The order of the steps in the array determines the order of their analysis (that is, the step at index 0 is the first step, the step at index 1 is the second step, and so on). items: type: object properties: title: type: string description: The name of the step action: type: object description: The analyzed event nullable: true required: - name properties: id: type: integer format: int64 deprecated: true nullable: true description: Deprecated parameter. DO NOT use. Has no effect in create/update requests. name: type: string description: Action name of the event. example: page.visit expressions: type: array description: An array of conditions that the event must meet items: type: object description: The `attribute` object is an event attribute that must exist in the analyzed event. The `constraint` object is a condition that the attribute must meet. properties: constraint: description: | This object defines the logic to apply to the `attribute`, and the values to compare it against (if required). **The analytics engine doesn't check if the data types match - you need to ensure that your data types are consistent in the data you send to the database**. discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintEventConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintEventConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintEventConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintEventConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintEventConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintEventConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintEventConstraint" "NULL": "#/components/schemas/analytics-NullConstraintEventConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintEventConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintEventConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintEventConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintEventConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolConstraintType type: string enum: - BOOL description: Tests a boolean value logic: x-class-name: BoolConstraintLogic type: string description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: title: String zero x-class-name: StringZeroConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: x-class-name: StringZeroConstraintLogic type: string description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: x-class-name: StringOneConstraintType type: string enum: - STRING_ONE description: This type is used to test values that are a single string. logic: x-class-name: StringOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: x-class-name: NumberOneConstraintType type: string enum: - NUMBER_ONE description: This type is used to test values that are a single number logic: x-class-name: NumberOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: x-class-name: NumberTwoConstraintType type: string enum: - NUMBER_TWO description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoConstraintLogic type: string enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: x-class-name: StringArrayConstraintType type: string enum: - STRING_ARRAY description: This type is used to check if a string exists in an array defined in `value` logic: type: string x-class-name: StringArrayConstraintLogic description: You can check if the value from `attribute` is in the array defined in `value` enum: - IN - NOT_IN value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: x-class-name: ArrayStringOneConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED description: "`value` should be an array" logic: x-class-name: ArrayStringOneConstraintLogic type: string description: | - CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullConstraintType description: This type is used to check if a value is null type: string enum: - "NULL" logic: x-class-name: NullConstraintLogic type: string description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: x-class-name: DateZeroConstraintType type: string enum: - DATE_ZERO description: Compare a date from `attribute` to the current date logic: x-class-name: LogicZeroConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR description: Logic to apply to the date from `attribute` required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: x-class-name: DateOneConstraintLogic type: string description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: x-class-name: DateTwoConstraintLogic type: string description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - description: This type is used to check if a date matches a date filter. type: object title: Date filter properties: type: x-class-name: DateFilterConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: x-class-name: DateFilterConstraintLogic type: string enum: - DATE_FILTER description: Checks if the date from `attribute` matches a date filter. value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - constrain - attribute required: - action - title - expressions exact: type: boolean default: false description: | When true, the profile's events must be exactly as in the funnel. For example, if the profile's history has events `A -> B -> C -> D`, and the funnel is `A -> C -> D`, the match is not exact, because there is an event between A and C. required: - title - steps - description: Definition of a profile filter type: object properties: type: x-class-name: ExpressionFilterExpressionContentType type: string enum: - EXPRESSION name: type: string matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true expressions: description: Profile filter details. The expressions are applied according to their position in the array. The logical AND/OR operator must be placed between expressions. An empty array means no filters are applied. type: array items: discriminator: propertyName: type mapping: ATTRIBUTE: "#/components/schemas/analytics-AttributeFilterBox" EXPRESSION: "#/components/schemas/analytics-ExpressionFilterBox" FUNNEL: "#/components/schemas/analytics-FunnelFilterBox" OPERATOR: "#/components/schemas/analytics-OperatorFilterBox" oneOf: - type: object properties: type: x-class-name: AttributeFilterBoxType type: string enum: - ATTRIBUTE description: Tests a profile attribute against a condition name: type: string description: Name of the resource matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true attribute: type: object description: The condition to test a profile attribute properties: expressions: type: array description: An array of conditions. All conditions must be met. items: type: object properties: constraint: discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintClientConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintClientConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintClientConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintClientConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintClientConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintClientConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintClientConstraint" "NULL": "#/components/schemas/analytics-NullConstraintClientConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintClientConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintClientConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintClientConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintClientConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolClientConstraintType type: string enum: - BOOL description: Tests a boolean value logic: description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. x-class-name: BoolClientConstraintLogic type: string enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: x-class-name: StringZeroClientConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. x-class-name: StringZeroClientConstraintLogic type: string enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: description: This type is used to test values that are a single string. x-class-name: StringOneClientConstraintType type: string enum: - STRING_ONE logic: description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". x-class-name: StringOneClientConstraintLogic type: string enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: description: This type is used to test values that are a single number x-class-name: NumberOneClientConstraintType type: string enum: - NUMBER_ONE logic: description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. x-class-name: NumberOneClientConstraintLogic type: string enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. x-class-name: NumberTwoClientConstraintType type: string enum: - NUMBER_TWO logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoClientConstraintLogic type: string enum: - BETWEEN value1: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue value2: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: description: This type is used to check if a string exists in an array defined in `value` x-class-name: StringArrayClientConstraintType type: string enum: - STRING_ARRAY logic: description: You can check if the value from `attribute` is in the array defined in `value` x-class-name: StringArrayClientConstraintLogic type: string enum: - IN - NOT_IN value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: description: "`value` should be an array" x-class-name: ArrayStringOneClientConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED logic: description: "- CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` " x-class-name: ArrayStringOneClientConstraintLogic type: string enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullClientConstraintType type: string enum: - "NULL" description: This type is used to check if a value is null logic: description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. x-class-name: NullClientConstraintLogic type: string enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: description: Compare a date from `attribute` to the current date x-class-name: DateZeroClientConstraintType type: string enum: - DATE_ZERO logic: description: Logic to apply to the date from `attribute` x-class-name: DateZeroClientConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneClientConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. x-class-name: DateOneClientConstraintLogic type: string enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoClientConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. x-class-name: DateTwoClientConstraintLogic type: string enum: - BETWEEN value1: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue value2: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Date filter description: This type is used to check if a date matches a date filter. properties: type: x-class-name: DateFilterClientConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: description: Checks if the date from `attribute` matches a date filter. x-class-name: DateFilterClientConstraintLogic type: string enum: - DATE_FILTER value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - expressions - description: A condition to test type: object properties: type: description: A condition to test x-class-name: ExpressionFilterBoxType type: string enum: - EXPRESSION name: type: string matching: type: boolean expressions: $ref: "#/components/schemas/analytics-FilterBox" required: - type - expressions - type: object properties: type: description: Tests against a funnel x-class-name: ExpressionFilterBoxType type: string enum: - FUNNEL name: type: string description: Name of the resource matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true funnel: type: object description: Funnel conditions properties: title: type: string description: Title of the funnel. completedWithin: type: object description: | Time constraint for completing all the steps in the funnel. Timer starts when the first step is triggered. - `period` sets the time unit - `value` sets the number of time units properties: period: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: description: The number of time units type: number format: int64 dateFilter: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type steps: type: array minItems: 0 description: An array of steps in the funnel. The order of the steps in the array determines the order of their analysis (that is, the step at index 0 is the first step, the step at index 1 is the second step, and so on). items: type: object properties: title: type: string description: The name of the step action: type: object description: The analyzed event nullable: true required: - name properties: id: type: integer format: int64 deprecated: true nullable: true description: Deprecated parameter. DO NOT use. Has no effect in create/update requests. name: type: string description: Action name of the event. example: page.visit expressions: type: array description: An array of conditions that the event must meet items: type: object description: The `attribute` object is an event attribute that must exist in the analyzed event. The `constraint` object is a condition that the attribute must meet. properties: constraint: description: | This object defines the logic to apply to the `attribute`, and the values to compare it against (if required). **The analytics engine doesn't check if the data types match - you need to ensure that your data types are consistent in the data you send to the database**. discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintEventConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintEventConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintEventConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintEventConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintEventConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintEventConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintEventConstraint" "NULL": "#/components/schemas/analytics-NullConstraintEventConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintEventConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintEventConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintEventConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintEventConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolConstraintType type: string enum: - BOOL description: Tests a boolean value logic: x-class-name: BoolConstraintLogic type: string description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: title: String zero x-class-name: StringZeroConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: x-class-name: StringZeroConstraintLogic type: string description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: x-class-name: StringOneConstraintType type: string enum: - STRING_ONE description: This type is used to test values that are a single string. logic: x-class-name: StringOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: x-class-name: NumberOneConstraintType type: string enum: - NUMBER_ONE description: This type is used to test values that are a single number logic: x-class-name: NumberOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: x-class-name: NumberTwoConstraintType type: string enum: - NUMBER_TWO description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoConstraintLogic type: string enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: x-class-name: StringArrayConstraintType type: string enum: - STRING_ARRAY description: This type is used to check if a string exists in an array defined in `value` logic: type: string x-class-name: StringArrayConstraintLogic description: You can check if the value from `attribute` is in the array defined in `value` enum: - IN - NOT_IN value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: x-class-name: ArrayStringOneConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED description: "`value` should be an array" logic: x-class-name: ArrayStringOneConstraintLogic type: string description: | - CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullConstraintType description: This type is used to check if a value is null type: string enum: - "NULL" logic: x-class-name: NullConstraintLogic type: string description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: x-class-name: DateZeroConstraintType type: string enum: - DATE_ZERO description: Compare a date from `attribute` to the current date logic: x-class-name: LogicZeroConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR description: Logic to apply to the date from `attribute` required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: x-class-name: DateOneConstraintLogic type: string description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: x-class-name: DateTwoConstraintLogic type: string description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - description: This type is used to check if a date matches a date filter. type: object title: Date filter properties: type: x-class-name: DateFilterConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: x-class-name: DateFilterConstraintLogic type: string enum: - DATE_FILTER description: Checks if the date from `attribute` matches a date filter. value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - constrain - attribute required: - action - title - expressions exact: type: boolean default: false description: | When true, the profile's events must be exactly as in the funnel. For example, if the profile's history has events `A -> B -> C -> D`, and the funnel is `A -> C -> D`, the match is not exact, because there is an event between A and C. required: - title - steps required: - type - funnel - type: object properties: type: description: Logical operator between expressions x-class-name: OperatorFilterBoxType type: string enum: - OPERATOR name: type: string description: Name of the resource logic: x-class-name: FilterBoxOperatorType type: string enum: - OR - AND - LEFT_BRACKET - RIGHT_BRACKET required: - type - name - logic expression: $ref: "#/components/schemas/analytics-FilterExpressionContent" required: - type - expressions - description: An empty value type: object properties: type: description: An empty value x-class-name: EmptyFilterExpressionContentType type: string enum: - EMPTY name: type: string required: - type groupBy: type: array items: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - matching - expressions - expression groupBy: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - title - aggregation - filter - type: object x-class-name: EventMetricExpression description: An event metric x-interface-name-ts: EventMetricExpression properties: type: type: string enum: - EVENT occurrenceType: type: string x-class-name: OccurrenceType x-interface-name-ts: OccurrenceType enum: - FIRST - LAST - ALL title: type: string description: Name of the resource aggregation: type: object x-class-name: EventMetricAggregation x-interface-name-ts: EventMetricAggregation properties: type: type: string description: | The type of calculation. - COUNT allows you to count the total number of the entities that meet the filters. - COUNT_DISTINCT allows you to count the total number of distinct (unique) attribute values in entities which match the filters. - SUM, MIN, MAX, MEDIAN, QUANTILE (requires `level`) and AVG allow you to perform calculations on numerical-value parameters within the entities that meet the filters. - EXISTS checks the existence of at least a single entity that meets the filters and returns 1 when "true" or 0 when "false". - LAST and LAST_MULTI (requires `size`) retrieve the newest matching data. - FIRST and FIRST_MULTI (requires `size`) retrieve the oldest matching data. - LAST_TIME and FIRST_TIME (running aggregates only; require `timeWindow`) retrieve the single newest / oldest matching value from events within the time window preceding the currently evaluated event. - LAST_MULTI_TIME and FIRST_MULTI_TIME (running aggregates only; require `size` and `timeWindow`) retrieve the newest / oldest matching data from events within the time window preceding the currently evaluated event. enum: - AVG - SUM - MIN - MAX - COUNT - MEDIAN - QUANTILE - COUNT_DISTINCT - LAST - FIRST - EXISTS - FIRST_MULTI - LAST_MULTI - FIRST_TIME - LAST_TIME - FIRST_MULTI_TIME - LAST_MULTI_TIME - TOP - BOTTOM - TOP_MULTI - BOTTOM_MULTI attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type level: type: number nullable: true required: - type - attribute dateFilter: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type action: type: object description: The analyzed event nullable: true required: - name properties: id: type: integer format: int64 deprecated: true nullable: true description: Deprecated parameter. DO NOT use. Has no effect in create/update requests. name: type: string description: Action name of the event. example: page.visit filter: type: object description: | This filter lets you limit the results to profiles that match it. For no filter, leave the object empty. The `expression` object is only used by the Synerise Web Portal. If you're integrating an API, don't send this object or send it empty. If you send `expression` and `expressions`, `expressions` takes priority. properties: matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true expressions: type: array description: Profile filter details. The expressions are applied according to their position in the array. The logical AND/OR operator must be placed between expressions. An empty array means no filters are applied. items: discriminator: propertyName: type mapping: ATTRIBUTE: "#/components/schemas/analytics-AttributeFilterBox" EXPRESSION: "#/components/schemas/analytics-ExpressionFilterBox" FUNNEL: "#/components/schemas/analytics-FunnelFilterBox" OPERATOR: "#/components/schemas/analytics-OperatorFilterBox" oneOf: - type: object properties: type: x-class-name: AttributeFilterBoxType type: string enum: - ATTRIBUTE description: Tests a profile attribute against a condition name: type: string description: Name of the resource matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true attribute: type: object description: The condition to test a profile attribute properties: expressions: type: array description: An array of conditions. All conditions must be met. items: type: object properties: constraint: discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintClientConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintClientConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintClientConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintClientConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintClientConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintClientConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintClientConstraint" "NULL": "#/components/schemas/analytics-NullConstraintClientConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintClientConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintClientConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintClientConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintClientConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolClientConstraintType type: string enum: - BOOL description: Tests a boolean value logic: description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. x-class-name: BoolClientConstraintLogic type: string enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: x-class-name: StringZeroClientConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. x-class-name: StringZeroClientConstraintLogic type: string enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: description: This type is used to test values that are a single string. x-class-name: StringOneClientConstraintType type: string enum: - STRING_ONE logic: description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". x-class-name: StringOneClientConstraintLogic type: string enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: description: This type is used to test values that are a single number x-class-name: NumberOneClientConstraintType type: string enum: - NUMBER_ONE logic: description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. x-class-name: NumberOneClientConstraintLogic type: string enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. x-class-name: NumberTwoClientConstraintType type: string enum: - NUMBER_TWO logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoClientConstraintLogic type: string enum: - BETWEEN value1: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue value2: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: description: This type is used to check if a string exists in an array defined in `value` x-class-name: StringArrayClientConstraintType type: string enum: - STRING_ARRAY logic: description: You can check if the value from `attribute` is in the array defined in `value` x-class-name: StringArrayClientConstraintLogic type: string enum: - IN - NOT_IN value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: description: "`value` should be an array" x-class-name: ArrayStringOneClientConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED logic: description: "- CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` " x-class-name: ArrayStringOneClientConstraintLogic type: string enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullClientConstraintType type: string enum: - "NULL" description: This type is used to check if a value is null logic: description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. x-class-name: NullClientConstraintLogic type: string enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: description: Compare a date from `attribute` to the current date x-class-name: DateZeroClientConstraintType type: string enum: - DATE_ZERO logic: description: Logic to apply to the date from `attribute` x-class-name: DateZeroClientConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneClientConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. x-class-name: DateOneClientConstraintLogic type: string enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoClientConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. x-class-name: DateTwoClientConstraintLogic type: string enum: - BETWEEN value1: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue value2: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Date filter description: This type is used to check if a date matches a date filter. properties: type: x-class-name: DateFilterClientConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: description: Checks if the date from `attribute` matches a date filter. x-class-name: DateFilterClientConstraintLogic type: string enum: - DATE_FILTER value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - expressions - description: A condition to test type: object properties: type: description: A condition to test x-class-name: ExpressionFilterBoxType type: string enum: - EXPRESSION name: type: string matching: type: boolean expressions: $ref: "#/components/schemas/analytics-FilterBox" required: - type - expressions - type: object properties: type: description: Tests against a funnel x-class-name: ExpressionFilterBoxType type: string enum: - FUNNEL name: type: string description: Name of the resource matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true funnel: type: object description: Funnel conditions properties: title: type: string description: Title of the funnel. completedWithin: type: object description: | Time constraint for completing all the steps in the funnel. Timer starts when the first step is triggered. - `period` sets the time unit - `value` sets the number of time units properties: period: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: description: The number of time units type: number format: int64 dateFilter: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type steps: type: array minItems: 0 description: An array of steps in the funnel. The order of the steps in the array determines the order of their analysis (that is, the step at index 0 is the first step, the step at index 1 is the second step, and so on). items: type: object properties: title: type: string description: The name of the step action: type: object description: The analyzed event nullable: true required: - name properties: id: type: integer format: int64 deprecated: true nullable: true description: Deprecated parameter. DO NOT use. Has no effect in create/update requests. name: type: string description: Action name of the event. example: page.visit expressions: type: array description: An array of conditions that the event must meet items: type: object description: The `attribute` object is an event attribute that must exist in the analyzed event. The `constraint` object is a condition that the attribute must meet. properties: constraint: description: | This object defines the logic to apply to the `attribute`, and the values to compare it against (if required). **The analytics engine doesn't check if the data types match - you need to ensure that your data types are consistent in the data you send to the database**. discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintEventConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintEventConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintEventConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintEventConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintEventConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintEventConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintEventConstraint" "NULL": "#/components/schemas/analytics-NullConstraintEventConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintEventConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintEventConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintEventConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintEventConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolConstraintType type: string enum: - BOOL description: Tests a boolean value logic: x-class-name: BoolConstraintLogic type: string description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: title: String zero x-class-name: StringZeroConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: x-class-name: StringZeroConstraintLogic type: string description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: x-class-name: StringOneConstraintType type: string enum: - STRING_ONE description: This type is used to test values that are a single string. logic: x-class-name: StringOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: x-class-name: NumberOneConstraintType type: string enum: - NUMBER_ONE description: This type is used to test values that are a single number logic: x-class-name: NumberOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: x-class-name: NumberTwoConstraintType type: string enum: - NUMBER_TWO description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoConstraintLogic type: string enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: x-class-name: StringArrayConstraintType type: string enum: - STRING_ARRAY description: This type is used to check if a string exists in an array defined in `value` logic: type: string x-class-name: StringArrayConstraintLogic description: You can check if the value from `attribute` is in the array defined in `value` enum: - IN - NOT_IN value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: x-class-name: ArrayStringOneConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED description: "`value` should be an array" logic: x-class-name: ArrayStringOneConstraintLogic type: string description: | - CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullConstraintType description: This type is used to check if a value is null type: string enum: - "NULL" logic: x-class-name: NullConstraintLogic type: string description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: x-class-name: DateZeroConstraintType type: string enum: - DATE_ZERO description: Compare a date from `attribute` to the current date logic: x-class-name: LogicZeroConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR description: Logic to apply to the date from `attribute` required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: x-class-name: DateOneConstraintLogic type: string description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: x-class-name: DateTwoConstraintLogic type: string description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - description: This type is used to check if a date matches a date filter. type: object title: Date filter properties: type: x-class-name: DateFilterConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: x-class-name: DateFilterConstraintLogic type: string enum: - DATE_FILTER description: Checks if the date from `attribute` matches a date filter. value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - constrain - attribute required: - action - title - expressions exact: type: boolean default: false description: | When true, the profile's events must be exactly as in the funnel. For example, if the profile's history has events `A -> B -> C -> D`, and the funnel is `A -> C -> D`, the match is not exact, because there is an event between A and C. required: - title - steps required: - type - funnel - type: object properties: type: description: Logical operator between expressions x-class-name: OperatorFilterBoxType type: string enum: - OPERATOR name: type: string description: Name of the resource logic: x-class-name: FilterBoxOperatorType type: string enum: - OR - AND - LEFT_BRACKET - RIGHT_BRACKET required: - type - name - logic expression: deprecated: true example: type: EMPTY discriminator: propertyName: type mapping: FUNCTION: "#/components/schemas/analytics-FilterExpressionFunction" ATTRIBUTE: "#/components/schemas/analytics-AttributeFilterExpressionContent" FUNNEL: "#/components/schemas/analytics-FunnelFilterExpressionContent" EXPRESSION: "#/components/schemas/analytics-ExpressionFilterExpressionContent" EMPTY: "#/components/schemas/analytics-EmptyFilterExpressionContent" oneOf: - type: object description: Logical operators properties: type: description: Logical operators x-class-name: FunctionFilterExpressionContentType type: string enum: - FUNCTION function: x-class-name: FilterFunctionType type: string enum: - AND - OR - BRACKET arg: type: object description: An argument of the function. This is a recursive schema; an argument can be a function which contains more functions in its arguments. x-codegen-schema: FilterExpressionContent arg1: type: object description: An argument of the function. This is a recursive schema; an argument can be a function which contains more functions in its arguments. x-codegen-schema: FilterExpressionContent arg2: type: object description: An argument of the function. This is a recursive schema; an argument can be a function which contains more functions in its arguments. x-codegen-schema: FilterExpressionContent name: type: string required: - type - function - type: object title: Profile attribute properties: type: x-class-name: AttributeFilterExpressionContentType type: string enum: - ATTRIBUTE description: Tests a profile attribute against a condition matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true attribute: type: object description: The condition to test a profile attribute properties: expressions: type: array description: An array of conditions. All conditions must be met. items: type: object properties: constraint: discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintClientConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintClientConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintClientConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintClientConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintClientConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintClientConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintClientConstraint" "NULL": "#/components/schemas/analytics-NullConstraintClientConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintClientConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintClientConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintClientConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintClientConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolClientConstraintType type: string enum: - BOOL description: Tests a boolean value logic: description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. x-class-name: BoolClientConstraintLogic type: string enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: x-class-name: StringZeroClientConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. x-class-name: StringZeroClientConstraintLogic type: string enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: description: This type is used to test values that are a single string. x-class-name: StringOneClientConstraintType type: string enum: - STRING_ONE logic: description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". x-class-name: StringOneClientConstraintLogic type: string enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: description: This type is used to test values that are a single number x-class-name: NumberOneClientConstraintType type: string enum: - NUMBER_ONE logic: description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. x-class-name: NumberOneClientConstraintLogic type: string enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. x-class-name: NumberTwoClientConstraintType type: string enum: - NUMBER_TWO logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoClientConstraintLogic type: string enum: - BETWEEN value1: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue value2: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: description: This type is used to check if a string exists in an array defined in `value` x-class-name: StringArrayClientConstraintType type: string enum: - STRING_ARRAY logic: description: You can check if the value from `attribute` is in the array defined in `value` x-class-name: StringArrayClientConstraintLogic type: string enum: - IN - NOT_IN value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: description: "`value` should be an array" x-class-name: ArrayStringOneClientConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED logic: description: "- CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` " x-class-name: ArrayStringOneClientConstraintLogic type: string enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullClientConstraintType type: string enum: - "NULL" description: This type is used to check if a value is null logic: description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. x-class-name: NullClientConstraintLogic type: string enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: description: Compare a date from `attribute` to the current date x-class-name: DateZeroClientConstraintType type: string enum: - DATE_ZERO logic: description: Logic to apply to the date from `attribute` x-class-name: DateZeroClientConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneClientConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. x-class-name: DateOneClientConstraintLogic type: string enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoClientConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. x-class-name: DateTwoClientConstraintLogic type: string enum: - BETWEEN value1: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue value2: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Date filter description: This type is used to check if a date matches a date filter. properties: type: x-class-name: DateFilterClientConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: description: Checks if the date from `attribute` matches a date filter. x-class-name: DateFilterClientConstraintLogic type: string enum: - DATE_FILTER value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - expressions - type: object title: Funnel properties: type: description: Tests against a funnel x-class-name: FunnelFilterExpressionContentType type: string enum: - FUNNEL matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true funnel: type: object description: Funnel conditions properties: title: type: string description: Title of the funnel. completedWithin: type: object description: | Time constraint for completing all the steps in the funnel. Timer starts when the first step is triggered. - `period` sets the time unit - `value` sets the number of time units properties: period: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: description: The number of time units type: number format: int64 dateFilter: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type steps: type: array minItems: 0 description: An array of steps in the funnel. The order of the steps in the array determines the order of their analysis (that is, the step at index 0 is the first step, the step at index 1 is the second step, and so on). items: type: object properties: title: type: string description: The name of the step action: type: object description: The analyzed event nullable: true required: - name properties: id: type: integer format: int64 deprecated: true nullable: true description: Deprecated parameter. DO NOT use. Has no effect in create/update requests. name: type: string description: Action name of the event. example: page.visit expressions: type: array description: An array of conditions that the event must meet items: type: object description: The `attribute` object is an event attribute that must exist in the analyzed event. The `constraint` object is a condition that the attribute must meet. properties: constraint: description: | This object defines the logic to apply to the `attribute`, and the values to compare it against (if required). **The analytics engine doesn't check if the data types match - you need to ensure that your data types are consistent in the data you send to the database**. discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintEventConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintEventConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintEventConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintEventConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintEventConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintEventConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintEventConstraint" "NULL": "#/components/schemas/analytics-NullConstraintEventConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintEventConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintEventConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintEventConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintEventConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolConstraintType type: string enum: - BOOL description: Tests a boolean value logic: x-class-name: BoolConstraintLogic type: string description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: title: String zero x-class-name: StringZeroConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: x-class-name: StringZeroConstraintLogic type: string description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: x-class-name: StringOneConstraintType type: string enum: - STRING_ONE description: This type is used to test values that are a single string. logic: x-class-name: StringOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: x-class-name: NumberOneConstraintType type: string enum: - NUMBER_ONE description: This type is used to test values that are a single number logic: x-class-name: NumberOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: x-class-name: NumberTwoConstraintType type: string enum: - NUMBER_TWO description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoConstraintLogic type: string enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: x-class-name: StringArrayConstraintType type: string enum: - STRING_ARRAY description: This type is used to check if a string exists in an array defined in `value` logic: type: string x-class-name: StringArrayConstraintLogic description: You can check if the value from `attribute` is in the array defined in `value` enum: - IN - NOT_IN value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: x-class-name: ArrayStringOneConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED description: "`value` should be an array" logic: x-class-name: ArrayStringOneConstraintLogic type: string description: | - CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullConstraintType description: This type is used to check if a value is null type: string enum: - "NULL" logic: x-class-name: NullConstraintLogic type: string description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: x-class-name: DateZeroConstraintType type: string enum: - DATE_ZERO description: Compare a date from `attribute` to the current date logic: x-class-name: LogicZeroConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR description: Logic to apply to the date from `attribute` required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: x-class-name: DateOneConstraintLogic type: string description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: x-class-name: DateTwoConstraintLogic type: string description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - description: This type is used to check if a date matches a date filter. type: object title: Date filter properties: type: x-class-name: DateFilterConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: x-class-name: DateFilterConstraintLogic type: string enum: - DATE_FILTER description: Checks if the date from `attribute` matches a date filter. value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - constrain - attribute required: - action - title - expressions exact: type: boolean default: false description: | When true, the profile's events must be exactly as in the funnel. For example, if the profile's history has events `A -> B -> C -> D`, and the funnel is `A -> C -> D`, the match is not exact, because there is an event between A and C. required: - title - steps - description: Definition of a profile filter type: object properties: type: x-class-name: ExpressionFilterExpressionContentType type: string enum: - EXPRESSION name: type: string matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true expressions: description: Profile filter details. The expressions are applied according to their position in the array. The logical AND/OR operator must be placed between expressions. An empty array means no filters are applied. type: array items: discriminator: propertyName: type mapping: ATTRIBUTE: "#/components/schemas/analytics-AttributeFilterBox" EXPRESSION: "#/components/schemas/analytics-ExpressionFilterBox" FUNNEL: "#/components/schemas/analytics-FunnelFilterBox" OPERATOR: "#/components/schemas/analytics-OperatorFilterBox" oneOf: - type: object properties: type: x-class-name: AttributeFilterBoxType type: string enum: - ATTRIBUTE description: Tests a profile attribute against a condition name: type: string description: Name of the resource matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true attribute: type: object description: The condition to test a profile attribute properties: expressions: type: array description: An array of conditions. All conditions must be met. items: type: object properties: constraint: discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintClientConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintClientConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintClientConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintClientConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintClientConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintClientConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintClientConstraint" "NULL": "#/components/schemas/analytics-NullConstraintClientConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintClientConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintClientConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintClientConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintClientConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolClientConstraintType type: string enum: - BOOL description: Tests a boolean value logic: description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. x-class-name: BoolClientConstraintLogic type: string enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: x-class-name: StringZeroClientConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. x-class-name: StringZeroClientConstraintLogic type: string enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: description: This type is used to test values that are a single string. x-class-name: StringOneClientConstraintType type: string enum: - STRING_ONE logic: description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". x-class-name: StringOneClientConstraintLogic type: string enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: description: This type is used to test values that are a single number x-class-name: NumberOneClientConstraintType type: string enum: - NUMBER_ONE logic: description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. x-class-name: NumberOneClientConstraintLogic type: string enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. x-class-name: NumberTwoClientConstraintType type: string enum: - NUMBER_TWO logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoClientConstraintLogic type: string enum: - BETWEEN value1: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue value2: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: description: This type is used to check if a string exists in an array defined in `value` x-class-name: StringArrayClientConstraintType type: string enum: - STRING_ARRAY logic: description: You can check if the value from `attribute` is in the array defined in `value` x-class-name: StringArrayClientConstraintLogic type: string enum: - IN - NOT_IN value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: description: "`value` should be an array" x-class-name: ArrayStringOneClientConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED logic: description: "- CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` " x-class-name: ArrayStringOneClientConstraintLogic type: string enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullClientConstraintType type: string enum: - "NULL" description: This type is used to check if a value is null logic: description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. x-class-name: NullClientConstraintLogic type: string enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: description: Compare a date from `attribute` to the current date x-class-name: DateZeroClientConstraintType type: string enum: - DATE_ZERO logic: description: Logic to apply to the date from `attribute` x-class-name: DateZeroClientConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneClientConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. x-class-name: DateOneClientConstraintLogic type: string enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoClientConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. x-class-name: DateTwoClientConstraintLogic type: string enum: - BETWEEN value1: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue value2: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Date filter description: This type is used to check if a date matches a date filter. properties: type: x-class-name: DateFilterClientConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: description: Checks if the date from `attribute` matches a date filter. x-class-name: DateFilterClientConstraintLogic type: string enum: - DATE_FILTER value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - expressions - description: A condition to test type: object properties: type: description: A condition to test x-class-name: ExpressionFilterBoxType type: string enum: - EXPRESSION name: type: string matching: type: boolean expressions: $ref: "#/components/schemas/analytics-FilterBox" required: - type - expressions - type: object properties: type: description: Tests against a funnel x-class-name: ExpressionFilterBoxType type: string enum: - FUNNEL name: type: string description: Name of the resource matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true funnel: type: object description: Funnel conditions properties: title: type: string description: Title of the funnel. completedWithin: type: object description: | Time constraint for completing all the steps in the funnel. Timer starts when the first step is triggered. - `period` sets the time unit - `value` sets the number of time units properties: period: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: description: The number of time units type: number format: int64 dateFilter: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type steps: type: array minItems: 0 description: An array of steps in the funnel. The order of the steps in the array determines the order of their analysis (that is, the step at index 0 is the first step, the step at index 1 is the second step, and so on). items: type: object properties: title: type: string description: The name of the step action: type: object description: The analyzed event nullable: true required: - name properties: id: type: integer format: int64 deprecated: true nullable: true description: Deprecated parameter. DO NOT use. Has no effect in create/update requests. name: type: string description: Action name of the event. example: page.visit expressions: type: array description: An array of conditions that the event must meet items: type: object description: The `attribute` object is an event attribute that must exist in the analyzed event. The `constraint` object is a condition that the attribute must meet. properties: constraint: description: | This object defines the logic to apply to the `attribute`, and the values to compare it against (if required). **The analytics engine doesn't check if the data types match - you need to ensure that your data types are consistent in the data you send to the database**. discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintEventConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintEventConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintEventConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintEventConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintEventConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintEventConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintEventConstraint" "NULL": "#/components/schemas/analytics-NullConstraintEventConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintEventConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintEventConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintEventConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintEventConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolConstraintType type: string enum: - BOOL description: Tests a boolean value logic: x-class-name: BoolConstraintLogic type: string description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: title: String zero x-class-name: StringZeroConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: x-class-name: StringZeroConstraintLogic type: string description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: x-class-name: StringOneConstraintType type: string enum: - STRING_ONE description: This type is used to test values that are a single string. logic: x-class-name: StringOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: x-class-name: NumberOneConstraintType type: string enum: - NUMBER_ONE description: This type is used to test values that are a single number logic: x-class-name: NumberOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: x-class-name: NumberTwoConstraintType type: string enum: - NUMBER_TWO description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoConstraintLogic type: string enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: x-class-name: StringArrayConstraintType type: string enum: - STRING_ARRAY description: This type is used to check if a string exists in an array defined in `value` logic: type: string x-class-name: StringArrayConstraintLogic description: You can check if the value from `attribute` is in the array defined in `value` enum: - IN - NOT_IN value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: x-class-name: ArrayStringOneConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED description: "`value` should be an array" logic: x-class-name: ArrayStringOneConstraintLogic type: string description: | - CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullConstraintType description: This type is used to check if a value is null type: string enum: - "NULL" logic: x-class-name: NullConstraintLogic type: string description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: x-class-name: DateZeroConstraintType type: string enum: - DATE_ZERO description: Compare a date from `attribute` to the current date logic: x-class-name: LogicZeroConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR description: Logic to apply to the date from `attribute` required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: x-class-name: DateOneConstraintLogic type: string description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: x-class-name: DateTwoConstraintLogic type: string description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - description: This type is used to check if a date matches a date filter. type: object title: Date filter properties: type: x-class-name: DateFilterConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: x-class-name: DateFilterConstraintLogic type: string enum: - DATE_FILTER description: Checks if the date from `attribute` matches a date filter. value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - constrain - attribute required: - action - title - expressions exact: type: boolean default: false description: | When true, the profile's events must be exactly as in the funnel. For example, if the profile's history has events `A -> B -> C -> D`, and the funnel is `A -> C -> D`, the match is not exact, because there is an event between A and C. required: - title - steps required: - type - funnel - type: object properties: type: description: Logical operator between expressions x-class-name: OperatorFilterBoxType type: string enum: - OPERATOR name: type: string description: Name of the resource logic: x-class-name: FilterBoxOperatorType type: string enum: - OR - AND - LEFT_BRACKET - RIGHT_BRACKET required: - type - name - logic expression: $ref: "#/components/schemas/analytics-FilterExpressionContent" required: - type - expressions - description: An empty value type: object properties: type: description: An empty value x-class-name: EmptyFilterExpressionContentType type: string enum: - EMPTY name: type: string required: - type groupBy: type: array items: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - matching - expressions - expression expressions: type: array description: An array of conditions that the event must meet items: type: object description: The `attribute` object is an event attribute that must exist in the analyzed event. The `constraint` object is a condition that the attribute must meet. properties: constraint: description: | This object defines the logic to apply to the `attribute`, and the values to compare it against (if required). **The analytics engine doesn't check if the data types match - you need to ensure that your data types are consistent in the data you send to the database**. discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintEventConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintEventConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintEventConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintEventConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintEventConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintEventConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintEventConstraint" "NULL": "#/components/schemas/analytics-NullConstraintEventConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintEventConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintEventConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintEventConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintEventConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolConstraintType type: string enum: - BOOL description: Tests a boolean value logic: x-class-name: BoolConstraintLogic type: string description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: title: String zero x-class-name: StringZeroConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: x-class-name: StringZeroConstraintLogic type: string description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: x-class-name: StringOneConstraintType type: string enum: - STRING_ONE description: This type is used to test values that are a single string. logic: x-class-name: StringOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: x-class-name: NumberOneConstraintType type: string enum: - NUMBER_ONE description: This type is used to test values that are a single number logic: x-class-name: NumberOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: x-class-name: NumberTwoConstraintType type: string enum: - NUMBER_TWO description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoConstraintLogic type: string enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: x-class-name: StringArrayConstraintType type: string enum: - STRING_ARRAY description: This type is used to check if a string exists in an array defined in `value` logic: type: string x-class-name: StringArrayConstraintLogic description: You can check if the value from `attribute` is in the array defined in `value` enum: - IN - NOT_IN value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: x-class-name: ArrayStringOneConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED description: "`value` should be an array" logic: x-class-name: ArrayStringOneConstraintLogic type: string description: | - CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullConstraintType description: This type is used to check if a value is null type: string enum: - "NULL" logic: x-class-name: NullConstraintLogic type: string description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: x-class-name: DateZeroConstraintType type: string enum: - DATE_ZERO description: Compare a date from `attribute` to the current date logic: x-class-name: LogicZeroConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR description: Logic to apply to the date from `attribute` required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: x-class-name: DateOneConstraintLogic type: string description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: x-class-name: DateTwoConstraintLogic type: string description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - description: This type is used to check if a date matches a date filter. type: object title: Date filter properties: type: x-class-name: DateFilterConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: x-class-name: DateFilterConstraintLogic type: string enum: - DATE_FILTER description: Checks if the date from `attribute` matches a date filter. value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - constrain - attribute eventName: type: string description: Name (action) of the analyzed event nullable: true required: - type - occurrenceType - title - aggregation - dateFilter - action - filter - expressions - type: object description: Reference to a metric x-class-name: NestedMetricExpression x-interface-name-ts: NestedMetricExpression properties: type: type: string enum: - METRIC id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c title: type: string description: Can't be empty, can't contain whitespace only required: - type - id - title - type: object x-class-name: NumberMetricExpression x-interface-name-ts: NumberMetricExpression properties: type: type: string enum: - NUMBER value: description: The numeric value type: number required: - type - value - type: object x-class-name: OperatorMetricExpression x-interface-name-ts: OperatorMetricExpression properties: type: type: string enum: - OPERATOR operator: type: string description: A mathematical/logical operator enum: - ADDITION_SIGN - SUBSTRACTION_SIGN - DIVISION_SIGN - MULTIPLICATION_SIGN - REMINDER - LEFT_BRACKET - RIGHT_BRACKET required: - type - operator isVisibleForClientProfile: type: boolean description: When set to `true`, information about this analysis is shown on a profile's card. allowNull: type: boolean default: true description: When `true`, null values can be included in the results. grouping: description: Defines how the results are returned type: array items: description: | The type and number of results to show. "TOP" shows the highest results. "LAST" shows the most recent results. discriminator: propertyName: type mapping: TOP: "#/components/schemas/analytics-TopReportMetricGrouping" LAST: "#/components/schemas/analytics-LastReportMetricGrouping" oneOf: - type: object title: Top required: - type - top properties: type: title: TopReportMetricGroupingType x-class-name: TopReportMetricGroupingType description: Returns the top results type: string enum: - TOP top: type: integer description: The number of results to show in the report - type: object title: Last description: This type shows the most recent occurrences required: - type - last properties: type: title: LastReportMetricGroupingType x-class-name: LastReportMetricGroupingType type: string description: This type shows the most recent occurrences enum: - LAST last: type: integer description: The number of results to show in the report required: - id - title - description - format - comparison - metricType - expression - isVisibleForClientProfile required: - id - analyticType - analysis discriminator: propertyName: analyticType mapping: EXPRESSION: "#/components/schemas/analytics-InlineExpression" SEGMENTATION: "#/components/schemas/analytics-InlineSegmentation" AGGREGATE: "#/components/schemas/analytics-InlineAggregate" RUNNING_AGGREGATE: "#/components/schemas/analytics-InlineRunningAggregate" METRIC: "#/components/schemas/analytics-InlineMetric" required: - analysis - isVisibleForClientProfile responses: "200": description: Aggregate updated 4XX: description: See error message for details content: application/json: schema: allOf: - type: object properties: source: type: object nullable: true description: Information about a parameter that caused the error, if applicable. properties: pointer: type: string description: Information about a parameter value: type: string nullable: true description: Currently unused errors: type: array description: An array of errors, if applicable items: type: object properties: timestamp: type: string format: date-time description: Time when the error occurred errorCode: type: string description: Code of the error, needed for troubleshooting. See [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html). httpStatus: type: integer description: HTTP status code message: type: string description: Description of the problem traceId: type: string description: Currently unused nullable: true help: type: string nullable: true description: Currently unused - type: object properties: timestamp: type: string format: date-time description: Time when the error occurred errorCode: type: string description: Code of the error, needed for troubleshooting. See [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html). httpStatus: type: integer description: HTTP status code message: type: string description: Description of the problem traceId: type: string description: Currently unused nullable: true help: type: string nullable: true description: Currently unused 5XX: description: See error message for details content: application/json: schema: allOf: - type: object properties: source: type: object nullable: true description: Information about a parameter that caused the error, if applicable. properties: pointer: type: string description: Information about a parameter value: type: string nullable: true description: Currently unused errors: type: array description: An array of errors, if applicable items: type: object properties: timestamp: type: string format: date-time description: Time when the error occurred errorCode: type: string description: Code of the error, needed for troubleshooting. See [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html). httpStatus: type: integer description: HTTP status code message: type: string description: Description of the problem traceId: type: string description: Currently unused nullable: true help: type: string nullable: true description: Currently unused - type: object properties: timestamp: type: string format: date-time description: Time when the error occurred errorCode: type: string description: Code of the error, needed for troubleshooting. See [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html). httpStatus: type: integer description: HTTP status code message: type: string description: Description of the problem traceId: type: string description: Currently unused nullable: true help: type: string nullable: true description: Currently unused security: - JWT: [] x-snr-doc-urls: - /api-reference/data-management#tag/Analytics:-Aggregates/operation/analytics2-aggregate-update x-codeSamples: - lang: cURL label: cURL source: |- curl --request PUT \ --url https://api.synerise.com/analytics/%7BNamespace%7D/aggregates/%7BAggregateIdentifier%7D \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \ --header 'content-type: application/json' \ --data '{"analysis":{"aggregateType":"AGGREGATE","id":0,"name":"string","description":"string","uuid":"5370bf3c-2dfa-4e89-98ff-07100cffee6c","type":"AVG","level":0.1,"size":0,"unique":true,"dateFilter":{"type":"ABSOLUTE","from":"2019-08-24T14:15:22Z","to":"2019-08-24T14:15:22Z","filter":{"type":"DAILY","nestingType":"IN_PLACE","from":"string","to":"string","inverted":false}},"expressions":[{"constraint":{"type":"BOOL","logic":"IS_TRUE"},"attribute":{"type":"PARAM","param":"string"}}],"attribute":{"type":"PARAM","param":"string"},"action":{"id":0,"name":"page.visit"}},"isVisibleForClientProfile":true,"aggregateType":"AGGREGATE","previewDefaultObjectId":0,"inlineAnalytics":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","analyticType":"EXPRESSION","analysis":{"type":"EVENT","action":{"id":0,"name":"page.visit"},"name":"string","description":"string","expression":{"type":"VALUE","title":"title","value":{"type":"CONSTANT","constant":10}}}}]}' - lang: Python label: Python source: |- import http.client conn = http.client.HTTPSConnection("api.synerise.com") payload = "{\"analysis\":{\"aggregateType\":\"AGGREGATE\",\"id\":0,\"name\":\"string\",\"description\":\"string\",\"uuid\":\"5370bf3c-2dfa-4e89-98ff-07100cffee6c\",\"type\":\"AVG\",\"level\":0.1,\"size\":0,\"unique\":true,\"dateFilter\":{\"type\":\"ABSOLUTE\",\"from\":\"2019-08-24T14:15:22Z\",\"to\":\"2019-08-24T14:15:22Z\",\"filter\":{\"type\":\"DAILY\",\"nestingType\":\"IN_PLACE\",\"from\":\"string\",\"to\":\"string\",\"inverted\":false}},\"expressions\":[{\"constraint\":{\"type\":\"BOOL\",\"logic\":\"IS_TRUE\"},\"attribute\":{\"type\":\"PARAM\",\"param\":\"string\"}}],\"attribute\":{\"type\":\"PARAM\",\"param\":\"string\"},\"action\":{\"id\":0,\"name\":\"page.visit\"}},\"isVisibleForClientProfile\":true,\"aggregateType\":\"AGGREGATE\",\"previewDefaultObjectId\":0,\"inlineAnalytics\":[{\"id\":\"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\"analyticType\":\"EXPRESSION\",\"analysis\":{\"type\":\"EVENT\",\"action\":{\"id\":0,\"name\":\"page.visit\"},\"name\":\"string\",\"description\":\"string\",\"expression\":{\"type\":\"VALUE\",\"title\":\"title\",\"value\":{\"type\":\"CONSTANT\",\"constant\":10}}}}]}" headers = { 'Authorization': "Bearer REPLACE_BEARER_TOKEN", 'content-type': "application/json" } conn.request("PUT", "/analytics/%7BNamespace%7D/aggregates/%7BAggregateIdentifier%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: JavaScript label: JavaScript source: |- const data = JSON.stringify({ "analysis": { "aggregateType": "AGGREGATE", "id": 0, "name": "string", "description": "string", "uuid": "5370bf3c-2dfa-4e89-98ff-07100cffee6c", "type": "AVG", "level": 0.1, "size": 0, "unique": true, "dateFilter": { "type": "ABSOLUTE", "from": "2019-08-24T14:15:22Z", "to": "2019-08-24T14:15:22Z", "filter": { "type": "DAILY", "nestingType": "IN_PLACE", "from": "string", "to": "string", "inverted": false } }, "expressions": [ { "constraint": { "type": "BOOL", "logic": "IS_TRUE" }, "attribute": { "type": "PARAM", "param": "string" } } ], "attribute": { "type": "PARAM", "param": "string" }, "action": { "id": 0, "name": "page.visit" } }, "isVisibleForClientProfile": true, "aggregateType": "AGGREGATE", "previewDefaultObjectId": 0, "inlineAnalytics": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "analyticType": "EXPRESSION", "analysis": { "type": "EVENT", "action": { "id": 0, "name": "page.visit" }, "name": "string", "description": "string", "expression": { "type": "VALUE", "title": "title", "value": { "type": "CONSTANT", "constant": 10 } } } } ] }); const xhr = new XMLHttpRequest(); xhr.withCredentials = true; xhr.addEventListener("readystatechange", function () { if (this.readyState === this.DONE) { console.log(this.responseText); } }); xhr.open("PUT", "https://api.synerise.com/analytics/%7BNamespace%7D/aggregates/%7BAggregateIdentifier%7D"); xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN"); xhr.setRequestHeader("content-type", "application/json"); xhr.send(data); - lang: Node.js label: Node.js source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "api.synerise.com", "port": null, "path": "/analytics/%7BNamespace%7D/aggregates/%7BAggregateIdentifier%7D", "headers": { "Authorization": "Bearer REPLACE_BEARER_TOKEN", "content-type": "application/json" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ analysis: { aggregateType: 'AGGREGATE', id: 0, name: 'string', description: 'string', uuid: '5370bf3c-2dfa-4e89-98ff-07100cffee6c', type: 'AVG', level: 0.1, size: 0, unique: true, dateFilter: { type: 'ABSOLUTE', from: '2019-08-24T14:15:22Z', to: '2019-08-24T14:15:22Z', filter: { type: 'DAILY', nestingType: 'IN_PLACE', from: 'string', to: 'string', inverted: false } }, expressions: [ { constraint: {type: 'BOOL', logic: 'IS_TRUE'}, attribute: {type: 'PARAM', param: 'string'} } ], attribute: {type: 'PARAM', param: 'string'}, action: {id: 0, name: 'page.visit'} }, isVisibleForClientProfile: true, aggregateType: 'AGGREGATE', previewDefaultObjectId: 0, inlineAnalytics: [ { id: '497f6eca-6276-4993-bfeb-53cbbbba6f08', analyticType: 'EXPRESSION', analysis: { type: 'EVENT', action: {id: 0, name: 'page.visit'}, name: 'string', description: 'string', expression: {type: 'VALUE', title: 'title', value: {type: 'CONSTANT', constant: 10}} } } ] })); req.end(); - lang: PHP label: PHP source: |- setUrl('https://api.synerise.com/analytics/%7BNamespace%7D/aggregates/%7BAggregateIdentifier%7D'); $request->setMethod(HTTP_METH_PUT); $request->setHeaders([ 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN', 'content-type' => 'application/json' ]); $request->setBody('{"analysis":{"aggregateType":"AGGREGATE","id":0,"name":"string","description":"string","uuid":"5370bf3c-2dfa-4e89-98ff-07100cffee6c","type":"AVG","level":0.1,"size":0,"unique":true,"dateFilter":{"type":"ABSOLUTE","from":"2019-08-24T14:15:22Z","to":"2019-08-24T14:15:22Z","filter":{"type":"DAILY","nestingType":"IN_PLACE","from":"string","to":"string","inverted":false}},"expressions":[{"constraint":{"type":"BOOL","logic":"IS_TRUE"},"attribute":{"type":"PARAM","param":"string"}}],"attribute":{"type":"PARAM","param":"string"},"action":{"id":0,"name":"page.visit"}},"isVisibleForClientProfile":true,"aggregateType":"AGGREGATE","previewDefaultObjectId":0,"inlineAnalytics":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","analyticType":"EXPRESSION","analysis":{"type":"EVENT","action":{"id":0,"name":"page.visit"},"name":"string","description":"string","expression":{"type":"VALUE","title":"title","value":{"type":"CONSTANT","constant":10}}}}]}'); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Java label: Java source: |- HttpResponse response = Unirest.put("https://api.synerise.com/analytics/%7BNamespace%7D/aggregates/%7BAggregateIdentifier%7D") .header("Authorization", "Bearer REPLACE_BEARER_TOKEN") .header("content-type", "application/json") .body("{\"analysis\":{\"aggregateType\":\"AGGREGATE\",\"id\":0,\"name\":\"string\",\"description\":\"string\",\"uuid\":\"5370bf3c-2dfa-4e89-98ff-07100cffee6c\",\"type\":\"AVG\",\"level\":0.1,\"size\":0,\"unique\":true,\"dateFilter\":{\"type\":\"ABSOLUTE\",\"from\":\"2019-08-24T14:15:22Z\",\"to\":\"2019-08-24T14:15:22Z\",\"filter\":{\"type\":\"DAILY\",\"nestingType\":\"IN_PLACE\",\"from\":\"string\",\"to\":\"string\",\"inverted\":false}},\"expressions\":[{\"constraint\":{\"type\":\"BOOL\",\"logic\":\"IS_TRUE\"},\"attribute\":{\"type\":\"PARAM\",\"param\":\"string\"}}],\"attribute\":{\"type\":\"PARAM\",\"param\":\"string\"},\"action\":{\"id\":0,\"name\":\"page.visit\"}},\"isVisibleForClientProfile\":true,\"aggregateType\":\"AGGREGATE\",\"previewDefaultObjectId\":0,\"inlineAnalytics\":[{\"id\":\"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\"analyticType\":\"EXPRESSION\",\"analysis\":{\"type\":\"EVENT\",\"action\":{\"id\":0,\"name\":\"page.visit\"},\"name\":\"string\",\"description\":\"string\",\"expression\":{\"type\":\"VALUE\",\"title\":\"title\",\"value\":{\"type\":\"CONSTANT\",\"constant\":10}}}}]}") .asString(); servers: - description: Microsoft Azure EU url: https://api.synerise.com - description: Microsoft Azure USA url: https://api.azu.synerise.com - description: Google Cloud Platform url: https://api.geb.synerise.com tags: - name: "Analytics: Aggregates" components: schemas: analytics-FilterBox: discriminator: propertyName: type mapping: ATTRIBUTE: "#/components/schemas/analytics-AttributeFilterBox" EXPRESSION: "#/components/schemas/analytics-ExpressionFilterBox" FUNNEL: "#/components/schemas/analytics-FunnelFilterBox" OPERATOR: "#/components/schemas/analytics-OperatorFilterBox" oneOf: - type: object properties: type: x-class-name: AttributeFilterBoxType type: string enum: - ATTRIBUTE description: Tests a profile attribute against a condition name: type: string description: Name of the resource matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true attribute: type: object description: The condition to test a profile attribute properties: expressions: type: array description: An array of conditions. All conditions must be met. items: type: object properties: constraint: discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintClientConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintClientConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintClientConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintClientConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintClientConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintClientConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintClientConstraint" "NULL": "#/components/schemas/analytics-NullConstraintClientConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintClientConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintClientConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintClientConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintClientConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolClientConstraintType type: string enum: - BOOL description: Tests a boolean value logic: description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. x-class-name: BoolClientConstraintLogic type: string enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: x-class-name: StringZeroClientConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. x-class-name: StringZeroClientConstraintLogic type: string enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: description: This type is used to test values that are a single string. x-class-name: StringOneClientConstraintType type: string enum: - STRING_ONE logic: description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". x-class-name: StringOneClientConstraintLogic type: string enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: description: This type is used to test values that are a single number x-class-name: NumberOneClientConstraintType type: string enum: - NUMBER_ONE logic: description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. x-class-name: NumberOneClientConstraintLogic type: string enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. x-class-name: NumberTwoClientConstraintType type: string enum: - NUMBER_TWO logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoClientConstraintLogic type: string enum: - BETWEEN value1: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue value2: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: description: This type is used to check if a string exists in an array defined in `value` x-class-name: StringArrayClientConstraintType type: string enum: - STRING_ARRAY logic: description: You can check if the value from `attribute` is in the array defined in `value` x-class-name: StringArrayClientConstraintLogic type: string enum: - IN - NOT_IN value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: description: "`value` should be an array" x-class-name: ArrayStringOneClientConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED logic: description: "- CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` " x-class-name: ArrayStringOneClientConstraintLogic type: string enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullClientConstraintType type: string enum: - "NULL" description: This type is used to check if a value is null logic: description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. x-class-name: NullClientConstraintLogic type: string enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: description: Compare a date from `attribute` to the current date x-class-name: DateZeroClientConstraintType type: string enum: - DATE_ZERO logic: description: Logic to apply to the date from `attribute` x-class-name: DateZeroClientConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneClientConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. x-class-name: DateOneClientConstraintLogic type: string enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoClientConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. x-class-name: DateTwoClientConstraintLogic type: string enum: - BETWEEN value1: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue value2: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Date filter description: This type is used to check if a date matches a date filter. properties: type: x-class-name: DateFilterClientConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: description: Checks if the date from `attribute` matches a date filter. x-class-name: DateFilterClientConstraintLogic type: string enum: - DATE_FILTER value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - expressions - description: A condition to test type: object properties: type: description: A condition to test x-class-name: ExpressionFilterBoxType type: string enum: - EXPRESSION name: type: string matching: type: boolean expressions: $ref: "#/components/schemas/analytics-FilterBox" required: - type - expressions - type: object properties: type: description: Tests against a funnel x-class-name: ExpressionFilterBoxType type: string enum: - FUNNEL name: type: string description: Name of the resource matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true funnel: type: object description: Funnel conditions properties: title: type: string description: Title of the funnel. completedWithin: type: object description: | Time constraint for completing all the steps in the funnel. Timer starts when the first step is triggered. - `period` sets the time unit - `value` sets the number of time units properties: period: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: description: The number of time units type: number format: int64 dateFilter: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type steps: type: array minItems: 0 description: An array of steps in the funnel. The order of the steps in the array determines the order of their analysis (that is, the step at index 0 is the first step, the step at index 1 is the second step, and so on). items: type: object properties: title: type: string description: The name of the step action: type: object description: The analyzed event nullable: true required: - name properties: id: type: integer format: int64 deprecated: true nullable: true description: Deprecated parameter. DO NOT use. Has no effect in create/update requests. name: type: string description: Action name of the event. example: page.visit expressions: type: array description: An array of conditions that the event must meet items: type: object description: The `attribute` object is an event attribute that must exist in the analyzed event. The `constraint` object is a condition that the attribute must meet. properties: constraint: description: | This object defines the logic to apply to the `attribute`, and the values to compare it against (if required). **The analytics engine doesn't check if the data types match - you need to ensure that your data types are consistent in the data you send to the database**. discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintEventConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintEventConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintEventConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintEventConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintEventConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintEventConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintEventConstraint" "NULL": "#/components/schemas/analytics-NullConstraintEventConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintEventConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintEventConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintEventConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintEventConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolConstraintType type: string enum: - BOOL description: Tests a boolean value logic: x-class-name: BoolConstraintLogic type: string description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: title: String zero x-class-name: StringZeroConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: x-class-name: StringZeroConstraintLogic type: string description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: x-class-name: StringOneConstraintType type: string enum: - STRING_ONE description: This type is used to test values that are a single string. logic: x-class-name: StringOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: x-class-name: NumberOneConstraintType type: string enum: - NUMBER_ONE description: This type is used to test values that are a single number logic: x-class-name: NumberOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: x-class-name: NumberTwoConstraintType type: string enum: - NUMBER_TWO description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoConstraintLogic type: string enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: x-class-name: StringArrayConstraintType type: string enum: - STRING_ARRAY description: This type is used to check if a string exists in an array defined in `value` logic: type: string x-class-name: StringArrayConstraintLogic description: You can check if the value from `attribute` is in the array defined in `value` enum: - IN - NOT_IN value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: x-class-name: ArrayStringOneConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED description: "`value` should be an array" logic: x-class-name: ArrayStringOneConstraintLogic type: string description: | - CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullConstraintType description: This type is used to check if a value is null type: string enum: - "NULL" logic: x-class-name: NullConstraintLogic type: string description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: x-class-name: DateZeroConstraintType type: string enum: - DATE_ZERO description: Compare a date from `attribute` to the current date logic: x-class-name: LogicZeroConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR description: Logic to apply to the date from `attribute` required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: x-class-name: DateOneConstraintLogic type: string description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: x-class-name: DateTwoConstraintLogic type: string description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - description: This type is used to check if a date matches a date filter. type: object title: Date filter properties: type: x-class-name: DateFilterConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: x-class-name: DateFilterConstraintLogic type: string enum: - DATE_FILTER description: Checks if the date from `attribute` matches a date filter. value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - constrain - attribute required: - action - title - expressions exact: type: boolean default: false description: | When true, the profile's events must be exactly as in the funnel. For example, if the profile's history has events `A -> B -> C -> D`, and the funnel is `A -> C -> D`, the match is not exact, because there is an event between A and C. required: - title - steps required: - type - funnel - type: object properties: type: description: Logical operator between expressions x-class-name: OperatorFilterBoxType type: string enum: - OPERATOR name: type: string description: Name of the resource logic: x-class-name: FilterBoxOperatorType type: string enum: - OR - AND - LEFT_BRACKET - RIGHT_BRACKET required: - type - name - logic analytics-FilterExpressionContent: deprecated: true example: type: EMPTY discriminator: propertyName: type mapping: FUNCTION: "#/components/schemas/analytics-FilterExpressionFunction" ATTRIBUTE: "#/components/schemas/analytics-AttributeFilterExpressionContent" FUNNEL: "#/components/schemas/analytics-FunnelFilterExpressionContent" EXPRESSION: "#/components/schemas/analytics-ExpressionFilterExpressionContent" EMPTY: "#/components/schemas/analytics-EmptyFilterExpressionContent" oneOf: - type: object description: Logical operators properties: type: description: Logical operators x-class-name: FunctionFilterExpressionContentType type: string enum: - FUNCTION function: x-class-name: FilterFunctionType type: string enum: - AND - OR - BRACKET arg: type: object description: An argument of the function. This is a recursive schema; an argument can be a function which contains more functions in its arguments. x-codegen-schema: FilterExpressionContent arg1: type: object description: An argument of the function. This is a recursive schema; an argument can be a function which contains more functions in its arguments. x-codegen-schema: FilterExpressionContent arg2: type: object description: An argument of the function. This is a recursive schema; an argument can be a function which contains more functions in its arguments. x-codegen-schema: FilterExpressionContent name: type: string required: - type - function - type: object title: Profile attribute properties: type: x-class-name: AttributeFilterExpressionContentType type: string enum: - ATTRIBUTE description: Tests a profile attribute against a condition matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true attribute: type: object description: The condition to test a profile attribute properties: expressions: type: array description: An array of conditions. All conditions must be met. items: type: object properties: constraint: discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintClientConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintClientConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintClientConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintClientConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintClientConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintClientConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintClientConstraint" "NULL": "#/components/schemas/analytics-NullConstraintClientConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintClientConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintClientConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintClientConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintClientConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolClientConstraintType type: string enum: - BOOL description: Tests a boolean value logic: description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. x-class-name: BoolClientConstraintLogic type: string enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: x-class-name: StringZeroClientConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. x-class-name: StringZeroClientConstraintLogic type: string enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: description: This type is used to test values that are a single string. x-class-name: StringOneClientConstraintType type: string enum: - STRING_ONE logic: description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". x-class-name: StringOneClientConstraintLogic type: string enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: description: This type is used to test values that are a single number x-class-name: NumberOneClientConstraintType type: string enum: - NUMBER_ONE logic: description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. x-class-name: NumberOneClientConstraintLogic type: string enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. x-class-name: NumberTwoClientConstraintType type: string enum: - NUMBER_TWO logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoClientConstraintLogic type: string enum: - BETWEEN value1: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue value2: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: description: This type is used to check if a string exists in an array defined in `value` x-class-name: StringArrayClientConstraintType type: string enum: - STRING_ARRAY logic: description: You can check if the value from `attribute` is in the array defined in `value` x-class-name: StringArrayClientConstraintLogic type: string enum: - IN - NOT_IN value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: description: "`value` should be an array" x-class-name: ArrayStringOneClientConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED logic: description: "- CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` " x-class-name: ArrayStringOneClientConstraintLogic type: string enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullClientConstraintType type: string enum: - "NULL" description: This type is used to check if a value is null logic: description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. x-class-name: NullClientConstraintLogic type: string enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: description: Compare a date from `attribute` to the current date x-class-name: DateZeroClientConstraintType type: string enum: - DATE_ZERO logic: description: Logic to apply to the date from `attribute` x-class-name: DateZeroClientConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneClientConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. x-class-name: DateOneClientConstraintLogic type: string enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoClientConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. x-class-name: DateTwoClientConstraintLogic type: string enum: - BETWEEN value1: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue value2: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Date filter description: This type is used to check if a date matches a date filter. properties: type: x-class-name: DateFilterClientConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: description: Checks if the date from `attribute` matches a date filter. x-class-name: DateFilterClientConstraintLogic type: string enum: - DATE_FILTER value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - expressions - type: object title: Funnel properties: type: description: Tests against a funnel x-class-name: FunnelFilterExpressionContentType type: string enum: - FUNNEL matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true funnel: type: object description: Funnel conditions properties: title: type: string description: Title of the funnel. completedWithin: type: object description: | Time constraint for completing all the steps in the funnel. Timer starts when the first step is triggered. - `period` sets the time unit - `value` sets the number of time units properties: period: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: description: The number of time units type: number format: int64 dateFilter: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type steps: type: array minItems: 0 description: An array of steps in the funnel. The order of the steps in the array determines the order of their analysis (that is, the step at index 0 is the first step, the step at index 1 is the second step, and so on). items: type: object properties: title: type: string description: The name of the step action: type: object description: The analyzed event nullable: true required: - name properties: id: type: integer format: int64 deprecated: true nullable: true description: Deprecated parameter. DO NOT use. Has no effect in create/update requests. name: type: string description: Action name of the event. example: page.visit expressions: type: array description: An array of conditions that the event must meet items: type: object description: The `attribute` object is an event attribute that must exist in the analyzed event. The `constraint` object is a condition that the attribute must meet. properties: constraint: description: | This object defines the logic to apply to the `attribute`, and the values to compare it against (if required). **The analytics engine doesn't check if the data types match - you need to ensure that your data types are consistent in the data you send to the database**. discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintEventConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintEventConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintEventConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintEventConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintEventConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintEventConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintEventConstraint" "NULL": "#/components/schemas/analytics-NullConstraintEventConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintEventConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintEventConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintEventConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintEventConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolConstraintType type: string enum: - BOOL description: Tests a boolean value logic: x-class-name: BoolConstraintLogic type: string description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: title: String zero x-class-name: StringZeroConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: x-class-name: StringZeroConstraintLogic type: string description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: x-class-name: StringOneConstraintType type: string enum: - STRING_ONE description: This type is used to test values that are a single string. logic: x-class-name: StringOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: x-class-name: NumberOneConstraintType type: string enum: - NUMBER_ONE description: This type is used to test values that are a single number logic: x-class-name: NumberOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: x-class-name: NumberTwoConstraintType type: string enum: - NUMBER_TWO description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoConstraintLogic type: string enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: x-class-name: StringArrayConstraintType type: string enum: - STRING_ARRAY description: This type is used to check if a string exists in an array defined in `value` logic: type: string x-class-name: StringArrayConstraintLogic description: You can check if the value from `attribute` is in the array defined in `value` enum: - IN - NOT_IN value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: x-class-name: ArrayStringOneConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED description: "`value` should be an array" logic: x-class-name: ArrayStringOneConstraintLogic type: string description: | - CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullConstraintType description: This type is used to check if a value is null type: string enum: - "NULL" logic: x-class-name: NullConstraintLogic type: string description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: x-class-name: DateZeroConstraintType type: string enum: - DATE_ZERO description: Compare a date from `attribute` to the current date logic: x-class-name: LogicZeroConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR description: Logic to apply to the date from `attribute` required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: x-class-name: DateOneConstraintLogic type: string description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: x-class-name: DateTwoConstraintLogic type: string description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - description: This type is used to check if a date matches a date filter. type: object title: Date filter properties: type: x-class-name: DateFilterConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: x-class-name: DateFilterConstraintLogic type: string enum: - DATE_FILTER description: Checks if the date from `attribute` matches a date filter. value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - constrain - attribute required: - action - title - expressions exact: type: boolean default: false description: | When true, the profile's events must be exactly as in the funnel. For example, if the profile's history has events `A -> B -> C -> D`, and the funnel is `A -> C -> D`, the match is not exact, because there is an event between A and C. required: - title - steps - description: Definition of a profile filter type: object properties: type: x-class-name: ExpressionFilterExpressionContentType type: string enum: - EXPRESSION name: type: string matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true expressions: description: Profile filter details. The expressions are applied according to their position in the array. The logical AND/OR operator must be placed between expressions. An empty array means no filters are applied. type: array items: discriminator: propertyName: type mapping: ATTRIBUTE: "#/components/schemas/analytics-AttributeFilterBox" EXPRESSION: "#/components/schemas/analytics-ExpressionFilterBox" FUNNEL: "#/components/schemas/analytics-FunnelFilterBox" OPERATOR: "#/components/schemas/analytics-OperatorFilterBox" oneOf: - type: object properties: type: x-class-name: AttributeFilterBoxType type: string enum: - ATTRIBUTE description: Tests a profile attribute against a condition name: type: string description: Name of the resource matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true attribute: type: object description: The condition to test a profile attribute properties: expressions: type: array description: An array of conditions. All conditions must be met. items: type: object properties: constraint: discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintClientConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintClientConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintClientConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintClientConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintClientConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintClientConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintClientConstraint" "NULL": "#/components/schemas/analytics-NullConstraintClientConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintClientConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintClientConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintClientConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintClientConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolClientConstraintType type: string enum: - BOOL description: Tests a boolean value logic: description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. x-class-name: BoolClientConstraintLogic type: string enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: x-class-name: StringZeroClientConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. x-class-name: StringZeroClientConstraintLogic type: string enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: description: This type is used to test values that are a single string. x-class-name: StringOneClientConstraintType type: string enum: - STRING_ONE logic: description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". x-class-name: StringOneClientConstraintLogic type: string enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: description: This type is used to test values that are a single number x-class-name: NumberOneClientConstraintType type: string enum: - NUMBER_ONE logic: description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. x-class-name: NumberOneClientConstraintLogic type: string enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. x-class-name: NumberTwoClientConstraintType type: string enum: - NUMBER_TWO logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoClientConstraintLogic type: string enum: - BETWEEN value1: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue value2: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: description: This type is used to check if a string exists in an array defined in `value` x-class-name: StringArrayClientConstraintType type: string enum: - STRING_ARRAY logic: description: You can check if the value from `attribute` is in the array defined in `value` x-class-name: StringArrayClientConstraintLogic type: string enum: - IN - NOT_IN value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: description: "`value` should be an array" x-class-name: ArrayStringOneClientConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED logic: description: "- CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` " x-class-name: ArrayStringOneClientConstraintLogic type: string enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullClientConstraintType type: string enum: - "NULL" description: This type is used to check if a value is null logic: description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. x-class-name: NullClientConstraintLogic type: string enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: description: Compare a date from `attribute` to the current date x-class-name: DateZeroClientConstraintType type: string enum: - DATE_ZERO logic: description: Logic to apply to the date from `attribute` x-class-name: DateZeroClientConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneClientConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. x-class-name: DateOneClientConstraintLogic type: string enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoClientConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. x-class-name: DateTwoClientConstraintLogic type: string enum: - BETWEEN value1: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue value2: discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantClientValue" CLIENT: "#/components/schemas/analytics-ClientAttributeValue" VARIABLE: "#/components/schemas/analytics-VariableClientValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantClientValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string - type: number - type: boolean - type: array items: type: string required: - type - constant - type: object title: Profile attribute properties: type: x-class-name: ClientClientValueType type: string enum: - CLIENT description: Definition of a profile attribute attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableClientValueType type: string description: This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. enum: - VARIABLE name: type: string description: The name of the dynamic key defaultValue: description: The default value to use oneOf: - type: string - type: number - type: array items: {} required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Date filter description: This type is used to check if a date matches a date filter. properties: type: x-class-name: DateFilterClientConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: description: Checks if the date from `attribute` matches a date filter. x-class-name: DateFilterClientConstraintLogic type: string enum: - DATE_FILTER value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - expressions - description: A condition to test type: object properties: type: description: A condition to test x-class-name: ExpressionFilterBoxType type: string enum: - EXPRESSION name: type: string matching: type: boolean expressions: $ref: "#/components/schemas/analytics-FilterBox" required: - type - expressions - type: object properties: type: description: Tests against a funnel x-class-name: ExpressionFilterBoxType type: string enum: - FUNNEL name: type: string description: Name of the resource matching: type: boolean description: When `true`, the results include only data that matched the condition. When `false`, the results include only data that did not match the condition. default: true funnel: type: object description: Funnel conditions properties: title: type: string description: Title of the funnel. completedWithin: type: object description: | Time constraint for completing all the steps in the funnel. Timer starts when the first step is triggered. - `period` sets the time unit - `value` sets the number of time units properties: period: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: description: The number of time units type: number format: int64 dateFilter: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type steps: type: array minItems: 0 description: An array of steps in the funnel. The order of the steps in the array determines the order of their analysis (that is, the step at index 0 is the first step, the step at index 1 is the second step, and so on). items: type: object properties: title: type: string description: The name of the step action: type: object description: The analyzed event nullable: true required: - name properties: id: type: integer format: int64 deprecated: true nullable: true description: Deprecated parameter. DO NOT use. Has no effect in create/update requests. name: type: string description: Action name of the event. example: page.visit expressions: type: array description: An array of conditions that the event must meet items: type: object description: The `attribute` object is an event attribute that must exist in the analyzed event. The `constraint` object is a condition that the attribute must meet. properties: constraint: description: | This object defines the logic to apply to the `attribute`, and the values to compare it against (if required). **The analytics engine doesn't check if the data types match - you need to ensure that your data types are consistent in the data you send to the database**. discriminator: propertyName: type mapping: BOOL: "#/components/schemas/analytics-BoolConstraintEventConstraint" STRING_ZERO: "#/components/schemas/analytics-StringZeroConstraintEventConstraint" STRING_ONE: "#/components/schemas/analytics-StringOneConstraintEventConstraint" NUMBER_ONE: "#/components/schemas/analytics-NumberOneConstraintEventConstraint" NUMBER_TWO: "#/components/schemas/analytics-NumberTwoConstraintEventConstraint" STRING_ARRAY: "#/components/schemas/analytics-StringArrayConstraintEventConstraint" ARRAY_STRING_ONE_DEPRECATED: "#/components/schemas/analytics-StringArrayOneConstraintEventConstraint" "NULL": "#/components/schemas/analytics-NullConstraintEventConstraint" DATE_ZERO: "#/components/schemas/analytics-DateZeroConstraintEventConstraint" DATE_ONE: "#/components/schemas/analytics-DateOneConstraintEventConstraint" DATE_TWO: "#/components/schemas/analytics-DateTwoConstraintEventConstraint" DATE_FILTER: "#/components/schemas/analytics-DateFilterConstraintEventConstraint" oneOf: - type: object title: Boolean properties: type: x-class-name: BoolConstraintType type: string enum: - BOOL description: Tests a boolean value logic: x-class-name: BoolConstraintLogic type: string description: Boolean logic. Empty (zero-length) strings, `0`, and `"0"` are considered false. Null values are false. enum: - IS_TRUE - IS_FALSE required: - type - logic - type: object title: Check empty description: This type is used to check if a string is empty. properties: type: title: String zero x-class-name: StringZeroConstraintType type: string description: This type is used to check if a string is empty. enum: - STRING_ZERO logic: x-class-name: StringZeroConstraintLogic type: string description: Checks if a string is empty (zero-length). Null value is considered empty. A string of whitespace characters is NOT empty. enum: - IS_EMPTY - IS_NOT_EMPTY required: - type - logic - type: object title: String properties: type: x-class-name: StringOneConstraintType type: string enum: - STRING_ONE description: This type is used to test values that are a single string. logic: x-class-name: StringOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `CONTAIN` and the `value` returns "foo", the expression checks if the `attribute` (sibling object to `constraint`) contains the string "foo". enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Number properties: type: x-class-name: NumberOneConstraintType type: string enum: - NUMBER_ONE description: This type is used to test values that are a single number logic: x-class-name: NumberOneConstraintLogic type: string description: Logic of the test. For example, if the logic is `EQUAL` and the `value` returns 15, the expression checks if the `attribute` (sibling object to `constraint`) is 15. enum: - EQUAL - NOT_EQUAL - LESS - MORE - MORE_OR_EQUAL - LESS_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Two numbers properties: type: x-class-name: NumberTwoConstraintType type: string enum: - NUMBER_TWO description: Checks if the `attribute` is between two numbers, defined in `value1` and `value2`. logic: description: Checks if the attribute is between two numbers. x-class-name: NumberTwoConstraintLogic type: string enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - type: object title: Check if string in array properties: type: x-class-name: StringArrayConstraintType type: string enum: - STRING_ARRAY description: This type is used to check if a string exists in an array defined in `value` logic: type: string x-class-name: StringArrayConstraintLogic description: You can check if the value from `attribute` is in the array defined in `value` enum: - IN - NOT_IN value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Other string array tests properties: type: x-class-name: ArrayStringOneConstraintType type: string enum: - ARRAY_STRING_ONE_DEPRECATED description: "`value` should be an array" logic: x-class-name: ArrayStringOneConstraintLogic type: string description: | - CONTAIN/NOT_CONTAIN test if any item in the array contains/doesn't contain the value from `attribute` - EQUAL/NOT_EQUAL test if any item in the array is/isn't identical to the value from `attribute` - STARTS_WITH/ENDS_WITH test if any item in the array starts/ends with the value from `attribute` - REGEXP tests if any item in the array matches the regular expression from `attribute` enum: - CONTAIN - NOT_CONTAIN - EQUAL - NOT_EQUAL - STARTS_WITH - REGEXP - ENDS_WITH value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - type: object title: Check if null properties: type: x-class-name: NullConstraintType description: This type is used to check if a value is null type: string enum: - "NULL" logic: x-class-name: NullConstraintLogic type: string description: Checks if the attribute is or isn't null. Empty strings, `0`, and negative numbers are NOT null. String `"null"` is NOT null. enum: - IS_NULL - IS_NOT_NULL required: - type - logic - type: object title: Current date properties: type: x-class-name: DateZeroConstraintType type: string enum: - DATE_ZERO description: Compare a date from `attribute` to the current date logic: x-class-name: LogicZeroConstraintLogic type: string enum: - MATCHES_CURRENT_DAY - MATCHES_CURRENT_HOUR - MATCHES_CURRENT_MONTH - MATCHES_CURRENT_YEAR description: Logic to apply to the date from `attribute` required: - type - logic - description: This type is used to check `attribute` against a date. type: object title: Date properties: type: x-class-name: DateOneConstraintType type: string description: This type is used to check `attribute` against a date. enum: - DATE_ONE logic: x-class-name: DateOneConstraintLogic type: string description: Checks how the date from `attribute` compares to the one in `value`. For example, MORE returns true if `attribute` is the later date. enum: - LESS - MORE - LESS_OR_EQUAL - MORE_OR_EQUAL value: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value - description: This type is used to check if a date is between two other dates. type: object title: Date range properties: type: x-class-name: DateTwoConstraintType type: string description: This type is used to check if a date is between two other dates. enum: - DATE_TWO logic: x-class-name: DateTwoConstraintLogic type: string description: Checks if the date from `attribute` is between the dates from `value1` and `value2`. enum: - BETWEEN value1: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue value2: description: The value to test `attribute` against. discriminator: propertyName: type mapping: CONSTANT: "#/components/schemas/analytics-ConstantValue" EVENT: "#/components/schemas/analytics-EventParameter" CLIENT: "#/components/schemas/analytics-ClientParameter" VARIABLE: "#/components/schemas/analytics-VariableValue" oneOf: - type: object title: Static value description: Inserts a static value. properties: type: x-class-name: ConstantValueType type: string description: Inserts a static value. enum: - CONSTANT constant: description: | The value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. oneOf: - type: string maxLength: 21000 - type: number - type: boolean - type: array maxItems: 65000 items: type: string maxLength: 21000 required: - type - constant - type: object title: Event parameter description: Inserts an event parameter value properties: type: x-class-name: EventParameterType description: Inserts an event parameter value type: string enum: - EVENT attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - type - attribute - type: object title: Profile attribute properties: type: description: References a profile attribute, including analyses. x-class-name: ClientEventValueType type: string enum: - CLIENT attribute: description: A profile attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ClientParamAttribute" TAG: "#/components/schemas/analytics-ClientTagAttribute" AGGREGATE: "#/components/schemas/analytics-ClientAggregateAttribute" SEGMENTATION: "#/components/schemas/analytics-ClientSegmentationAttribute" EXPRESSION: "#/components/schemas/analytics-ClientExpressionAttribute" SPECIAL: "#/components/schemas/analytics-ClientSpecialAttribute" EMPTY: "#/components/schemas/analytics-ClientEmptyAttribute" oneOf: - type: object properties: type: type: string enum: - PARAM param: description: Name of the parameter type: string required: - type - param - type: object description: Reference to a tag properties: type: type: string enum: - TAG tag: description: Name of the tag type: string required: - type - tag - type: object properties: type: type: string enum: - AGGREGATE uuid: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - uuid - id - type: object description: Reference to a segmentation properties: type: type: string enum: - SEGMENTATION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Pointer to an expression properties: type: type: string enum: - EXPRESSION id: type: string format: uuid description: | UUID of the analysis example: 5370bf3c-2dfa-4e89-98ff-07100cffee6c required: - type - id - type: object description: Reference to a special parameter properties: type: type: string enum: - SPECIAL special: type: string description: The name of the special parameter required: - type - special - type: object properties: type: type: string enum: - EMPTY required: - type required: - type - attribute - type: object title: Dynamic value properties: type: x-class-name: VariableValueType type: string enum: - VARIABLE description: | This type is called a Dynamic Key in the Synerise Portal. It can be used to let other analytic components, such as dashboards, insert a value. The variable value can't: - be longer than 21000 characters if it's a string - be larger than 65000 items if it's an array. Strings in the array can't be longer than 21000 characters. name: type: string description: The name of the dynamic key defaultValue: type: string maxLength: 21000 description: The default value to use required: - type - name - defaultValue required: - type - logic - value1 - value2 - description: This type is used to check if a date matches a date filter. type: object title: Date filter properties: type: x-class-name: DateFilterConstraintType type: string description: This type is used to check if a date matches a date filter. enum: - DATE_FILTER logic: x-class-name: DateFilterConstraintLogic type: string enum: - DATE_FILTER description: Checks if the date from `attribute` matches a date filter. value: description: | Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis. discriminator: propertyName: type mapping: ABSOLUTE: "#/components/schemas/analytics-AbsoluteDateFilter" RELATIVE: "#/components/schemas/analytics-RelativeDateFilter" oneOf: - type: object title: AbsoluteDateFilter properties: type: title: AbsoluteDateFilterType x-class-name: AbsoluteDateFilterType x-interface-name-ts: AbsoluteDateFilterType type: string enum: - ABSOLUTE description: Absolute filters have the same start and end regardless of when the analysis is calculated. from: type: string format: date-time description: The lower boundary of the date filter. to: type: string format: date-time description: The upper boundary of the date filter. Must be later than `from`. filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - type - type: object title: RelativeDateFilter properties: type: title: RelativeDateFilterType x-class-name: RelativeDateFilterType x-interface-name-ts: RelativeDateFilterType type: string enum: - RELATIVE description: | Relative filters allow you to create a filter that depends on when the analysis is calculated. - `duration` is the length of time that the filter covers. - `offset` is the time that the filter goes back to set the beginning of the duration. duration: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value offset: type: object description: The definition of a length of time. properties: type: type: string x-class-name: TimePeriod x-interface-name-ts: TimePeriod description: The unit of time enum: - YEARS - MONTHS - WEEKS - DAYS - HOURS - MINUTES - SECONDS - UNKNOWN value: type: integer description: The number of time units format: int64 required: - type - value filter: description: This object allows you to define a pattern for a more detailed time filter. These patterns are applied within the constraints of the `dateFilter` object that contains them, regardless of its type relative or absolute). oneOf: - type: object title: Daily x-class-name: CustomDailyFilter x-interface-name-ts: CustomDailyFilter properties: type: type: string x-class-name: CustomDailyFilterType x-interface-name-ts: CustomDailyFilterType enum: - DAILY description: Daily filters limit the data scope to a range of hours every day. nestingType: x-class-name: CustomDailyFilterNestingType type: string enum: - IN_PLACE from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - nestingType - type - from - to - type: object title: Weekly x-class-name: CustomWeeklyFilter x-interface-name-ts: CustomWeeklyFilter properties: type: type: string x-class-name: CustomWeeklyFilterType x-interface-name-ts: CustomWeeklyFilterType enum: - WEEKLY description: Weekly filters let you define separate rules for each day of the week. nestingType: x-class-name: CustomWeeklyFilterNestingType type: string enum: - IN_PLACE days: type: array description: An array of rules for different days of the week. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - nestingType - type - type: object title: Monthly x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType properties: type: type: string x-class-name: CustomMonthlyFilterType x-interface-name-ts: CustomMonthlyFilterType enum: - MONTHLY description: Monthly filters allow you to build rules for days of the month and/or weeks, including rules for different days of the week. nestingType: x-class-name: CustomMonthlyFilterNestingType type: string enum: - IN_PLACE rules: description: A set of rules. Within a monthly filter, you can include a mixture of rules for days of the month and days of the week. oneOf: - type: object title: Days of the week x-class-name: WeekDateRule x-interface-name-ts: WeekDateRule properties: type: type: string x-class-name: WeekDateRuleType x-interface-name-ts: WeekDateRuleType enum: - WEEK description: Weekly filters limit the scope to days in a week weeks: type: array description: Weeks of the month included in the pattern items: type: object properties: week: type: integer description: Number of the week. The direction of counting depends on the `inverted` boolean property of the ancestor object. days: type: array description: Days included in the pattern items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to required: - days - type inverted: type: boolean default: false description: | When set to `true`, weeks are counted from the end of the month. For example, if `inverted` is true and `week` is set to 1, the rule applies to the last week of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array of each week.. required: - type - weeks - type: object title: Days of the month x-class-name: MonthDateRule x-interface-name-ts: MonthDateRule properties: type: description: Rules for days of the month type: string x-class-name: MonthDateRuleType x-interface-name-ts: MonthDateRuleType enum: - MONTH days: type: array description: Days of the month included in the pattern. items: type: object properties: day: type: integer description: The day that this rule applies to. In weekly patterns, `1` is Monday (Sunday if inverted). from: type: string description: Lower boundary of the pattern's timeframe, in HH:MM:SS format. to: type: string description: Upper boundary of the pattern's timeframe, in HH:MM:SS format. mode: type: string enum: - Range - Hour inverted: type: boolean default: false description: "Inverts the pattern's timeframe. For example: if `from` is 12:00:00; `to` is 14:00:00; and `inverted` is true, the analysis does NOT include anything between 12:00:01 and 13:59:59." required: - day - from - inverted - to inverted: type: boolean default: false description: | When set to `true`, days are counted from the end of the month. For example, if `inverted` is true and `day` is set to 1, the rule applies to the last day of each month. This lets you take into account the varying length of months. **NOTE:** Remember that this `inverted` field is not the same as the `inverted` field of each object in the `days` array. required: - days - type discriminator: propertyName: type mapping: WEEK: "#/components/schemas/analytics-WeekDateRule" MONTH: "#/components/schemas/analytics-MonthDateRule" required: - nestingType - rules - type discriminator: propertyName: type mapping: DAILY: "#/components/schemas/analytics-CustomDailyDateFilter" WEEKLY: "#/components/schemas/analytics-CustomWeeklyDateFilter" MONTHLY: "#/components/schemas/analytics-CustomMonthlyDateFilter" required: - duration - offset - type required: - type - logic - value attribute: description: An event attribute to analyze discriminator: propertyName: type mapping: PARAM: "#/components/schemas/analytics-ParameterEventAttribute" RUNNING_AGGREGATE: "#/components/schemas/analytics-RunningAggregateEventAttribute" EXPRESSION: "#/components/schemas/analytics-ExpressionEventAttribute" SPECIAL: "#/components/schemas/analytics-SpecialEventAttribute" EMPTY: "#/components/schemas/analytics-EmptyEventAttribute" oneOf: - type: object title: Event parameter properties: type: x-class-name: ParamEventAttributeType enum: - PARAM description: This `type` refers to parameters in an event. param: type: string description: Name of the parameter required: - type - type: object title: Event aggregate properties: type: x-class-name: RunningAggregateEventAttributeType type: string enum: - RUNNING_AGGREGATE description: This type refers to event aggregates. You must provide the ID of the aggregate. id: type: string format: uuid description: ID of the event aggregate required: - type - id - type: object title: Expression properties: type: x-class-name: ExpressionEventAttributeType type: string enum: - EXPRESSION description: This type refers to expressions. You must provide the ID of the expression. id: type: string format: uuid description: ID of the expression required: - type - id - type: object title: Special property properties: type: x-class-name: SpecialEventAttributeType type: string enum: - SPECIAL description: This type lets you access special properties of an event. special: type: string description: The type of special attribute you want to use enum: - TIMESTAMP required: - type - special - type: object title: No attribute properties: type: x-class-name: EmptyEventAttributeType type: string enum: - EMPTY description: Can be used for analyses whose result isn't based on an attribute, such as `EXISTS`. **Can't be used with `constraint`**. required: - type required: - constrain - attribute required: - action - title - expressions exact: type: boolean default: false description: | When true, the profile's events must be exactly as in the funnel. For example, if the profile's history has events `A -> B -> C -> D`, and the funnel is `A -> C -> D`, the match is not exact, because there is an event between A and C. required: - title - steps required: - type - funnel - type: object properties: type: description: Logical operator between expressions x-class-name: OperatorFilterBoxType type: string enum: - OPERATOR name: type: string description: Name of the resource logic: x-class-name: FilterBoxOperatorType type: string enum: - OR - AND - LEFT_BRACKET - RIGHT_BRACKET required: - type - name - logic expression: $ref: "#/components/schemas/analytics-FilterExpressionContent" required: - type - expressions - description: An empty value type: object properties: type: description: An empty value x-class-name: EmptyFilterExpressionContentType type: string enum: - EMPTY name: type: string required: - type securitySchemes: JWT: type: http scheme: bearer description: |- JWT Bearer token. The header looks like this: `Bearer {JWT}` Remember to include the space between 'Bearer' and the token. Generate a token via the **Authorization** endpoints. ```