monitor_schema.models.ColumnMatrix#

class monitor_schema.models.ColumnMatrix[source]#

Define the matrix of columns and segments to fan out for monitoring.

Show JSON schema
{
   "title": "ColumnMatrix",
   "description": "Define the matrix of columns and segments to fan out for monitoring.",
   "type": "object",
   "properties": {
      "segments": {
         "title": "Segments",
         "description": "List of targeted segments. If not set, default to the overall segment",
         "maxItems": 1000,
         "type": "array",
         "items": {
            "$ref": "#/definitions/Segment"
         }
      },
      "excludeSegments": {
         "title": "Excludesegments",
         "description": "List of segments to be excluded",
         "maxItems": 1000,
         "type": "array",
         "items": {
            "$ref": "#/definitions/Segment"
         }
      },
      "type": {
         "title": "Type",
         "enum": [
            "column"
         ],
         "type": "string"
      },
      "include": {
         "title": "Include",
         "description": "List of allowed fields/features/columns. Could be a grouping as well.",
         "maxItems": 1000,
         "type": "array",
         "items": {
            "anyOf": [
               {
                  "$ref": "#/definitions/ColumnGroups"
               },
               {
                  "type": "string",
                  "maxLength": 1000
               }
            ]
         }
      },
      "exclude": {
         "title": "Exclude",
         "description": "List of blocked fields/features/columns. Could be a grouping as well. This setting is evaluated AFTER the 'include' field and thus should be used with caution.",
         "maxItems": 1000,
         "type": "array",
         "items": {
            "anyOf": [
               {
                  "$ref": "#/definitions/ColumnGroups"
               },
               {
                  "type": "string",
                  "maxLength": 1000
               }
            ]
         }
      },
      "profileId": {
         "title": "ProfileId",
         "description": "The unique profile ID for the reference profile",
         "maxLength": 100,
         "type": "string"
      }
   },
   "required": [
      "type"
   ],
   "additionalProperties": false,
   "definitions": {
      "SegmentTag": {
         "title": "SegmentTag",
         "description": "A single tag key value pair for a segment.",
         "type": "object",
         "properties": {
            "key": {
               "title": "Key",
               "maxLength": 1000,
               "type": "string"
            },
            "value": {
               "title": "Value",
               "maxLength": 1000,
               "type": "string"
            }
         },
         "required": [
            "key",
            "value"
         ],
         "additionalProperties": false
      },
      "Segment": {
         "title": "Segment",
         "description": "A segment is a list of tags.\n\nWe normalize these in the backend.",
         "type": "object",
         "properties": {
            "tags": {
               "title": "Tags",
               "description": "List of tags that define the specific segment",
               "maxItems": 10,
               "type": "array",
               "items": {
                  "$ref": "#/definitions/SegmentTag"
               }
            }
         },
         "required": [
            "tags"
         ],
         "additionalProperties": false
      },
      "ColumnGroups": {
         "title": "ColumnGroups",
         "description": "Standard column groupings.",
         "enum": [
            "group:continuous",
            "group:discrete",
            "group:input",
            "group:output"
         ],
         "type": "string"
      }
   }
}

Fields:
field exclude: List[ColumnGroups | ConstrainedStrValue] | None = None#

List of blocked fields/features/columns. Could be a grouping as well. This setting is evaluated AFTER the ‘include’ field and thus should be used with caution.

Constraints:

  • maxItems = 1000

field include: List[ColumnGroups | ConstrainedStrValue] | None = None#

List of allowed fields/features/columns. Could be a grouping as well.

Constraints:

  • maxItems = 1000

field profileId: str | None = None#

The unique profile ID for the reference profile

Constraints:

  • maxLength = 100

field type: column: 'column'>] [Required]#