Input schema (JSON)
{
"type": "object",
"required": [
"dashboardId",
"name",
"type"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"description": "Panel title as the team will read it."
},
"text": {
"type": "string",
"maxLength": 2000,
"description": "For type \"text\": the Markdown body. A heading for a row of panels, or a short note on how to read them. Your own words only: never paste captured data (error messages, payloads, URLs) into it."
},
"type": {
"enum": [
"funnel",
"retention",
"trends",
"issues",
"text",
"sql"
],
"type": "string",
"description": "funnel, retention and trends first; sql only when they cannot express it."
},
"view": {
"enum": [
"steps",
"timeToConvert",
"trend",
"compare",
"bar",
"table"
],
"type": "string",
"description": "Funnels only: steps (default, the drop-off per step), compare (each step beside the period before, for \"did the change help\"), timeToConvert, trend (conversion rate over time), bar or table."
},
"chart": {
"enum": [
"line",
"area",
"bar",
"hbar",
"share",
"heatmap",
"scalar",
"table"
],
"type": "string",
"description": "For trends: line (default) over time; area for a total made of parts over time (stacked with `display.stacked`); bar to compare segments over time; hbar to rank segments by their total (long names, top pages, plans); share for each segment's part of the whole (a breakdown over the window, up to six slices); heatmap for when one series happens across the week (weekday × hour, UTC; one series, no breakdown); scalar for one number; table for rows. For retention: table (default, the cohort grid) or line (the average curve). For sql: table (default), line or bar."
},
"query": {
"type": "string",
"maxLength": 4096,
"description": "For type \"sql\": the VinktarQL SELECT."
},
"funnel": {
"type": "object",
"required": [
"steps"
],
"properties": {
"order": {
"enum": [
"ordered",
"strict",
"any"
],
"type": "string",
"description": "\"ordered\" (default): steps in sequence, other events allowed between; \"strict\": nothing between; \"any\": any order."
},
"steps": {
"type": "array",
"items": {
"type": "object",
"required": [
"event"
],
"properties": {
"event": {
"type": "string",
"maxLength": 200
},
"label": {
"type": "string",
"maxLength": 100
},
"filters": {
"type": "object",
"required": [
"combinator"
],
"properties": {
"groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"combinator"
],
"properties": {
"groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"combinator"
],
"properties": {
"groups": {
"type": "array",
"maxItems": 0
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"property",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"contains",
"gt",
"lt",
"is_set"
],
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
},
"maxItems": 100
},
"property": {
"type": "object",
"required": [
"scope",
"key"
],
"properties": {
"key": {
"type": "string",
"maxLength": 1000
},
"scope": {
"enum": [
"event",
"context",
"session",
"user"
],
"type": "string"
}
},
"description": "{scope, key}. scope \"event\" = payload property, \"context\" = built-in dimension (country, browser, page_path, utm_source…), \"session\", \"user\" = user trait.",
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
},
"combinator": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"description": "Filters combined with AND/OR: {combinator: \"AND\", filters: [{property: {scope, key}, op, values: [..]}], groups: [nested groups]}. Ops: eq, neq, in, contains, gt, lt, is_set. Values are strings.",
"additionalProperties": false
},
"maxItems": 5
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"property",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"contains",
"gt",
"lt",
"is_set"
],
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
},
"maxItems": 100
},
"property": {
"type": "object",
"required": [
"scope",
"key"
],
"properties": {
"key": {
"type": "string",
"maxLength": 1000
},
"scope": {
"enum": [
"event",
"context",
"session",
"user"
],
"type": "string"
}
},
"description": "{scope, key}. scope \"event\" = payload property, \"context\" = built-in dimension (country, browser, page_path, utm_source…), \"session\", \"user\" = user trait.",
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
},
"combinator": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"description": "Filters combined with AND/OR: {combinator: \"AND\", filters: [{property: {scope, key}, op, values: [..]}], groups: [nested groups]}. Ops: eq, neq, in, contains, gt, lt, is_set. Values are strings.",
"additionalProperties": false
},
"maxItems": 5
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"property",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"contains",
"gt",
"lt",
"is_set"
],
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
},
"maxItems": 100
},
"property": {
"type": "object",
"required": [
"scope",
"key"
],
"properties": {
"key": {
"type": "string",
"maxLength": 1000
},
"scope": {
"enum": [
"event",
"context",
"session",
"user"
],
"type": "string"
}
},
"description": "{scope, key}. scope \"event\" = payload property, \"context\" = built-in dimension (country, browser, page_path, utm_source…), \"session\", \"user\" = user trait.",
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 20
},
"combinator": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"description": "Filters combined with AND/OR: {combinator: \"AND\", filters: [{property: {scope, key}, op, values: [..]}], groups: [nested groups]}. Ops: eq, neq, in, contains, gt, lt, is_set. Values are strings.",
"additionalProperties": false
},
"breakdown": {
"type": "object",
"required": [
"scope",
"key"
],
"properties": {
"key": {
"type": "string",
"maxLength": 1000
},
"scope": {
"enum": [
"event",
"context",
"session",
"user"
],
"type": "string"
}
},
"description": "{scope, key}. scope \"event\" = payload property, \"context\" = built-in dimension (country, browser, page_path, utm_source…), \"session\", \"user\" = user trait.",
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10,
"minItems": 2,
"description": "Ordered steps: {event, label?, filters?}."
},
"filters": {
"type": "object",
"required": [
"combinator"
],
"properties": {
"groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"combinator"
],
"properties": {
"groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"combinator"
],
"properties": {
"groups": {
"type": "array",
"maxItems": 0
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"property",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"contains",
"gt",
"lt",
"is_set"
],
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
},
"maxItems": 100
},
"property": {
"type": "object",
"required": [
"scope",
"key"
],
"properties": {
"key": {
"type": "string",
"maxLength": 1000
},
"scope": {
"enum": [
"event",
"context",
"session",
"user"
],
"type": "string"
}
},
"description": "{scope, key}. scope \"event\" = payload property, \"context\" = built-in dimension (country, browser, page_path, utm_source…), \"session\", \"user\" = user trait.",
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
},
"combinator": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"description": "Filters combined with AND/OR: {combinator: \"AND\", filters: [{property: {scope, key}, op, values: [..]}], groups: [nested groups]}. Ops: eq, neq, in, contains, gt, lt, is_set. Values are strings.",
"additionalProperties": false
},
"maxItems": 5
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"property",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"contains",
"gt",
"lt",
"is_set"
],
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
},
"maxItems": 100
},
"property": {
"type": "object",
"required": [
"scope",
"key"
],
"properties": {
"key": {
"type": "string",
"maxLength": 1000
},
"scope": {
"enum": [
"event",
"context",
"session",
"user"
],
"type": "string"
}
},
"description": "{scope, key}. scope \"event\" = payload property, \"context\" = built-in dimension (country, browser, page_path, utm_source…), \"session\", \"user\" = user trait.",
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
},
"combinator": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"description": "Filters combined with AND/OR: {combinator: \"AND\", filters: [{property: {scope, key}, op, values: [..]}], groups: [nested groups]}. Ops: eq, neq, in, contains, gt, lt, is_set. Values are strings.",
"additionalProperties": false
},
"maxItems": 5
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"property",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"contains",
"gt",
"lt",
"is_set"
],
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
},
"maxItems": 100
},
"property": {
"type": "object",
"required": [
"scope",
"key"
],
"properties": {
"key": {
"type": "string",
"maxLength": 1000
},
"scope": {
"enum": [
"event",
"context",
"session",
"user"
],
"type": "string"
}
},
"description": "{scope, key}. scope \"event\" = payload property, \"context\" = built-in dimension (country, browser, page_path, utm_source…), \"session\", \"user\" = user trait.",
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 20
},
"combinator": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"description": "Filters combined with AND/OR: {combinator: \"AND\", filters: [{property: {scope, key}, op, values: [..]}], groups: [nested groups]}. Ops: eq, neq, in, contains, gt, lt, is_set. Values are strings.",
"additionalProperties": false
},
"breakdown": {
"type": "object",
"required": [
"scope",
"key"
],
"properties": {
"key": {
"type": "string",
"maxLength": 1000
},
"scope": {
"enum": [
"event",
"context",
"session",
"user"
],
"type": "string"
}
},
"description": "{scope, key}. scope \"event\" = payload property, \"context\" = built-in dimension (country, browser, page_path, utm_source…), \"session\", \"user\" = user trait.",
"additionalProperties": false
},
"conversionWindow": {
"type": "object",
"required": [
"value",
"unit"
],
"properties": {
"unit": {
"enum": [
"minute",
"hour",
"day",
"week",
"month"
],
"type": "string"
},
"value": {
"type": "integer",
"maximum": 365,
"minimum": 1
}
},
"description": "How long an entrant has to finish, e.g. {value: 1, unit: \"day\"}. Default 1 day.",
"additionalProperties": false
}
},
"additionalProperties": false
},
"issues": {
"type": "object",
"properties": {
"sort": {
"enum": [
"occurrences",
"users",
"recent"
],
"type": "string",
"description": "Default \"occurrences\"."
},
"limit": {
"type": "integer",
"maximum": 10,
"minimum": 1,
"description": "Rows shown, default 5."
},
"environment": {
"type": "string",
"maxLength": 64,
"description": "Only this environment, e.g. \"production\". Omit for all."
}
},
"description": "For type \"issues\": the top error issues inside the board's window. Every field is optional.",
"additionalProperties": false
},
"trends": {
"type": "object",
"required": [
"series"
],
"properties": {
"series": {
"type": "array",
"items": {
"type": "object",
"required": [
"aggregation"
],
"properties": {
"event": {
"type": "string",
"maxLength": 200,
"description": "Event name; omit for all events."
},
"label": {
"type": "string",
"maxLength": 100
},
"filters": {
"type": "object",
"required": [
"combinator"
],
"properties": {
"groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"combinator"
],
"properties": {
"groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"combinator"
],
"properties": {
"groups": {
"type": "array",
"maxItems": 0
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"property",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"contains",
"gt",
"lt",
"is_set"
],
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
},
"maxItems": 100
},
"property": {
"type": "object",
"required": [
"scope",
"key"
],
"properties": {
"key": {
"type": "string",
"maxLength": 1000
},
"scope": {
"enum": [
"event",
"context",
"session",
"user"
],
"type": "string"
}
},
"description": "{scope, key}. scope \"event\" = payload property, \"context\" = built-in dimension (country, browser, page_path, utm_source…), \"session\", \"user\" = user trait.",
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
},
"combinator": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"description": "Filters combined with AND/OR: {combinator: \"AND\", filters: [{property: {scope, key}, op, values: [..]}], groups: [nested groups]}. Ops: eq, neq, in, contains, gt, lt, is_set. Values are strings.",
"additionalProperties": false
},
"maxItems": 5
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"property",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"contains",
"gt",
"lt",
"is_set"
],
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
},
"maxItems": 100
},
"property": {
"type": "object",
"required": [
"scope",
"key"
],
"properties": {
"key": {
"type": "string",
"maxLength": 1000
},
"scope": {
"enum": [
"event",
"context",
"session",
"user"
],
"type": "string"
}
},
"description": "{scope, key}. scope \"event\" = payload property, \"context\" = built-in dimension (country, browser, page_path, utm_source…), \"session\", \"user\" = user trait.",
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
},
"combinator": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"description": "Filters combined with AND/OR: {combinator: \"AND\", filters: [{property: {scope, key}, op, values: [..]}], groups: [nested groups]}. Ops: eq, neq, in, contains, gt, lt, is_set. Values are strings.",
"additionalProperties": false
},
"maxItems": 5
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"property",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"contains",
"gt",
"lt",
"is_set"
],
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
},
"maxItems": 100
},
"property": {
"type": "object",
"required": [
"scope",
"key"
],
"properties": {
"key": {
"type": "string",
"maxLength": 1000
},
"scope": {
"enum": [
"event",
"context",
"session",
"user"
],
"type": "string"
}
},
"description": "{scope, key}. scope \"event\" = payload property, \"context\" = built-in dimension (country, browser, page_path, utm_source…), \"session\", \"user\" = user trait.",
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 20
},
"combinator": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"description": "Filters combined with AND/OR: {combinator: \"AND\", filters: [{property: {scope, key}, op, values: [..]}], groups: [nested groups]}. Ops: eq, neq, in, contains, gt, lt, is_set. Values are strings.",
"additionalProperties": false
},
"property": {
"type": "object",
"required": [
"scope",
"key"
],
"properties": {
"key": {
"type": "string",
"maxLength": 1000
},
"scope": {
"enum": [
"event",
"context",
"session",
"user"
],
"type": "string"
}
},
"description": "{scope, key}. scope \"event\" = payload property, \"context\" = built-in dimension (country, browser, page_path, utm_source…), \"session\", \"user\" = user trait.",
"additionalProperties": false
},
"breakdown": {
"type": "object",
"required": [
"scope",
"key"
],
"properties": {
"key": {
"type": "string",
"maxLength": 1000
},
"scope": {
"enum": [
"event",
"context",
"session",
"user"
],
"type": "string"
}
},
"description": "{scope, key}. scope \"event\" = payload property, \"context\" = built-in dimension (country, browser, page_path, utm_source…), \"session\", \"user\" = user trait.",
"additionalProperties": false
},
"aggregation": {
"enum": [
"total",
"unique_users",
"unique_sessions",
"sum",
"avg",
"p95"
],
"type": "string"
}
},
"additionalProperties": false
},
"maxItems": 5,
"minItems": 1,
"description": "One to five metrics. Each: {event, aggregation, property?, filters?, label?, breakdown?}. `property` is required for sum, avg and p95."
},
"filters": {
"type": "object",
"required": [
"combinator"
],
"properties": {
"groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"combinator"
],
"properties": {
"groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"combinator"
],
"properties": {
"groups": {
"type": "array",
"maxItems": 0
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"property",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"contains",
"gt",
"lt",
"is_set"
],
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
},
"maxItems": 100
},
"property": {
"type": "object",
"required": [
"scope",
"key"
],
"properties": {
"key": {
"type": "string",
"maxLength": 1000
},
"scope": {
"enum": [
"event",
"context",
"session",
"user"
],
"type": "string"
}
},
"description": "{scope, key}. scope \"event\" = payload property, \"context\" = built-in dimension (country, browser, page_path, utm_source…), \"session\", \"user\" = user trait.",
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
},
"combinator": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"description": "Filters combined with AND/OR: {combinator: \"AND\", filters: [{property: {scope, key}, op, values: [..]}], groups: [nested groups]}. Ops: eq, neq, in, contains, gt, lt, is_set. Values are strings.",
"additionalProperties": false
},
"maxItems": 5
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"property",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"contains",
"gt",
"lt",
"is_set"
],
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
},
"maxItems": 100
},
"property": {
"type": "object",
"required": [
"scope",
"key"
],
"properties": {
"key": {
"type": "string",
"maxLength": 1000
},
"scope": {
"enum": [
"event",
"context",
"session",
"user"
],
"type": "string"
}
},
"description": "{scope, key}. scope \"event\" = payload property, \"context\" = built-in dimension (country, browser, page_path, utm_source…), \"session\", \"user\" = user trait.",
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
},
"combinator": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"description": "Filters combined with AND/OR: {combinator: \"AND\", filters: [{property: {scope, key}, op, values: [..]}], groups: [nested groups]}. Ops: eq, neq, in, contains, gt, lt, is_set. Values are strings.",
"additionalProperties": false
},
"maxItems": 5
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"property",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"contains",
"gt",
"lt",
"is_set"
],
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
},
"maxItems": 100
},
"property": {
"type": "object",
"required": [
"scope",
"key"
],
"properties": {
"key": {
"type": "string",
"maxLength": 1000
},
"scope": {
"enum": [
"event",
"context",
"session",
"user"
],
"type": "string"
}
},
"description": "{scope, key}. scope \"event\" = payload property, \"context\" = built-in dimension (country, browser, page_path, utm_source…), \"session\", \"user\" = user trait.",
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 20
},
"combinator": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"description": "Filters combined with AND/OR: {combinator: \"AND\", filters: [{property: {scope, key}, op, values: [..]}], groups: [nested groups]}. Ops: eq, neq, in, contains, gt, lt, is_set. Values are strings.",
"additionalProperties": false
},
"breakdowns": {
"type": "array",
"items": {
"type": "object",
"required": [
"scope",
"key"
],
"properties": {
"key": {
"type": "string",
"maxLength": 1000
},
"scope": {
"enum": [
"event",
"context",
"session",
"user"
],
"type": "string"
}
},
"description": "{scope, key}. scope \"event\" = payload property, \"context\" = built-in dimension (country, browser, page_path, utm_source…), \"session\", \"user\" = user trait.",
"additionalProperties": false
},
"maxItems": 1,
"description": "Split every series without its own `breakdown` by one property."
}
},
"additionalProperties": false
},
"display": {
"type": "object",
"properties": {
"note": {
"type": "string",
"maxLength": 280,
"description": "One plain sentence under the title on how to read the panel or what changed. Your own words, never captured data."
},
"format": {
"enum": [
"count",
"currency",
"percent"
],
"type": "string",
"description": "currency for money, percent for a rate; default count."
},
"legend": {
"type": "boolean",
"description": "Line charts: show the legend. Default true."
},
"stacked": {
"type": "boolean",
"description": "Bar charts with several series: stack them. Default true."
},
"thresholds": {
"type": "array",
"items": {
"type": "object",
"required": [
"value",
"color"
],
"properties": {
"color": {
"enum": [
"green",
"amber",
"red",
"blue"
],
"type": "string",
"description": "green at the target, red at the limit, amber for a warning before it, blue to mark a level without judging it."
},
"value": {
"type": "number",
"description": "In the panel's own unit: 0.25 for 25% with format percent."
}
},
"additionalProperties": false
},
"maxItems": 5,
"description": "Up to five values the user named to read the panel against (a target, a limit, an error budget). A chart draws each as a dashed line in its colour; a number takes the colour of the highest one it has reached. Only values the user gave; never invent one."
}
},
"description": "How the panel reads. format, stacked and legend are for trends and sql; thresholds and note for any panel but text."
},
"projects": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128
},
"maxItems": 50,
"description": "The projects this panel reads, by handle or id: a panel keeps its own set, so one board can hold panels over different apps. Leave out for every project this connection reaches."
},
"retention": {
"type": "object",
"required": [
"targetEvent",
"returningEvent"
],
"properties": {
"period": {
"enum": [
"day",
"week",
"month"
],
"type": "string",
"description": "Cohort granularity. Default \"week\"."
},
"filters": {
"type": "object",
"required": [
"combinator"
],
"properties": {
"groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"combinator"
],
"properties": {
"groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"combinator"
],
"properties": {
"groups": {
"type": "array",
"maxItems": 0
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"property",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"contains",
"gt",
"lt",
"is_set"
],
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
},
"maxItems": 100
},
"property": {
"type": "object",
"required": [
"scope",
"key"
],
"properties": {
"key": {
"type": "string",
"maxLength": 1000
},
"scope": {
"enum": [
"event",
"context",
"session",
"user"
],
"type": "string"
}
},
"description": "{scope, key}. scope \"event\" = payload property, \"context\" = built-in dimension (country, browser, page_path, utm_source…), \"session\", \"user\" = user trait.",
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
},
"combinator": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"description": "Filters combined with AND/OR: {combinator: \"AND\", filters: [{property: {scope, key}, op, values: [..]}], groups: [nested groups]}. Ops: eq, neq, in, contains, gt, lt, is_set. Values are strings.",
"additionalProperties": false
},
"maxItems": 5
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"property",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"contains",
"gt",
"lt",
"is_set"
],
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
},
"maxItems": 100
},
"property": {
"type": "object",
"required": [
"scope",
"key"
],
"properties": {
"key": {
"type": "string",
"maxLength": 1000
},
"scope": {
"enum": [
"event",
"context",
"session",
"user"
],
"type": "string"
}
},
"description": "{scope, key}. scope \"event\" = payload property, \"context\" = built-in dimension (country, browser, page_path, utm_source…), \"session\", \"user\" = user trait.",
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
},
"combinator": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"description": "Filters combined with AND/OR: {combinator: \"AND\", filters: [{property: {scope, key}, op, values: [..]}], groups: [nested groups]}. Ops: eq, neq, in, contains, gt, lt, is_set. Values are strings.",
"additionalProperties": false
},
"maxItems": 5
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"property",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"contains",
"gt",
"lt",
"is_set"
],
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
},
"maxItems": 100
},
"property": {
"type": "object",
"required": [
"scope",
"key"
],
"properties": {
"key": {
"type": "string",
"maxLength": 1000
},
"scope": {
"enum": [
"event",
"context",
"session",
"user"
],
"type": "string"
}
},
"description": "{scope, key}. scope \"event\" = payload property, \"context\" = built-in dimension (country, browser, page_path, utm_source…), \"session\", \"user\" = user trait.",
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 20
},
"combinator": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"description": "Filters combined with AND/OR: {combinator: \"AND\", filters: [{property: {scope, key}, op, values: [..]}], groups: [nested groups]}. Ops: eq, neq, in, contains, gt, lt, is_set. Values are strings.",
"additionalProperties": false
},
"periods": {
"type": "integer",
"maximum": 12,
"minimum": 2,
"description": "Periods each cohort is tracked for. Default 8."
},
"targetEvent": {
"type": "string",
"maxLength": 200,
"description": "The event that puts a user in a cohort (e.g. \"signup\")."
},
"returningEvent": {
"type": "string",
"maxLength": 200,
"description": "The event that counts as coming back (e.g. \"session_start\")."
}
},
"additionalProperties": false
},
"sqlReason": {
"type": "string",
"maxLength": 300,
"minLength": 10,
"description": "For type \"sql\", required: why no funnel, retention or trends panel can show this."
},
"dashboardId": {
"type": "string",
"pattern": "^\\d{1,19}$",
"description": "The board, from list_boards or create_board."
}
},
"additionalProperties": false
}