monitor_schema.models.DatasetMatrix

class monitor_schema.models.DatasetMatrix

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

.

Show JSON schema

{
   "title": "DatasetMatrix",
   "description": "Define the matrix of fields and segments to fan out for monitoring.\n\n.",
   "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",
         "description": "Must be 'dataset' level",
         "default": "dataset",
         "enum": [
            "dataset"
         ],
         "type": "string"
      }
   },
   "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
      }
   }
}

Fields:

• type (Literal[

field type: dataset: 'dataset'>] = TargetLevel.dataset

Must be ‘dataset’ level