Raw schema
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"create",
"update",
"promote",
"delete"
]
},
"id": {
"description": "Required for update/promote/delete.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"name": {
"description": "Required for create. Optional for update โ pass it to rename the view; omit to leave the name unchanged.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"rev": {
"description": "Required for update โ the rev this edit is based on; stale vs. the view's CURRENT rev returns a structured conflict with currentRev/currentLayout to rebase onto.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"layout": {
"description": "Required for create/update.",
"type": "object",
"properties": {
"schemaVersion": {
"type": "number",
"const": 1
},
"widgets": {
"maxItems": 50,
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"type": {
"type": "string",
"const": "kpi_row"
},
"gridPos": {
"type": "object",
"properties": {
"x": {
"type": "integer",
"minimum": 0,
"maximum": 11
},
"y": {
"type": "integer",
"minimum": 0,
"maximum": 1000
},
"w": {
"type": "integer",
"minimum": 1,
"maximum": 12
},
"h": {
"type": "integer",
"minimum": 1,
"maximum": 20
}
},
"required": [
"x",
"y",
"w",
"h"
]
},
"visible": {
"default": true,
"type": "boolean"
},
"props": {
"type": "object",
"properties": {
"refreshSeconds": {
"default": 30,
"type": "integer",
"minimum": 5,
"maximum": 3600
},
"title": {
"type": "string",
"maxLength": 200
},
"metrics": {
"default": [
"sent",
"reply",
"bounce"
],
"minItems": 1,
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"enum": [
"sent",
"reply",
"bounce",
"soft_bounce",
"complaint",
"unsubscribe",
"failed"
]
}
}
}
}
},
"required": [
"id",
"type",
"gridPos",
"props"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"type": {
"type": "string",
"const": "mailbox_health"
},
"gridPos": {
"type": "object",
"properties": {
"x": {
"type": "integer",
"minimum": 0,
"maximum": 11
},
"y": {
"type": "integer",
"minimum": 0,
"maximum": 1000
},
"w": {
"type": "integer",
"minimum": 1,
"maximum": 12
},
"h": {
"type": "integer",
"minimum": 1,
"maximum": 20
}
},
"required": [
"x",
"y",
"w",
"h"
]
},
"visible": {
"default": true,
"type": "boolean"
},
"props": {
"type": "object",
"properties": {
"refreshSeconds": {
"default": 30,
"type": "integer",
"minimum": 5,
"maximum": 3600
},
"title": {
"type": "string",
"maxLength": 200
},
"showWarmup": {
"default": true,
"type": "boolean"
}
}
}
},
"required": [
"id",
"type",
"gridPos",
"props"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"type": {
"type": "string",
"const": "campaign_performance"
},
"gridPos": {
"type": "object",
"properties": {
"x": {
"type": "integer",
"minimum": 0,
"maximum": 11
},
"y": {
"type": "integer",
"minimum": 0,
"maximum": 1000
},
"w": {
"type": "integer",
"minimum": 1,
"maximum": 12
},
"h": {
"type": "integer",
"minimum": 1,
"maximum": 20
}
},
"required": [
"x",
"y",
"w",
"h"
]
},
"visible": {
"default": true,
"type": "boolean"
},
"props": {
"type": "object",
"properties": {
"refreshSeconds": {
"default": 30,
"type": "integer",
"minimum": 5,
"maximum": 3600
},
"title": {
"type": "string",
"maxLength": 200
},
"campaignId": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
}
}
},
"required": [
"id",
"type",
"gridPos",
"props"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"type": {
"type": "string",
"const": "activity_feed"
},
"gridPos": {
"type": "object",
"properties": {
"x": {
"type": "integer",
"minimum": 0,
"maximum": 11
},
"y": {
"type": "integer",
"minimum": 0,
"maximum": 1000
},
"w": {
"type": "integer",
"minimum": 1,
"maximum": 12
},
"h": {
"type": "integer",
"minimum": 1,
"maximum": 20
}
},
"required": [
"x",
"y",
"w",
"h"
]
},
"visible": {
"default": true,
"type": "boolean"
},
"props": {
"type": "object",
"properties": {
"refreshSeconds": {
"default": 30,
"type": "integer",
"minimum": 5,
"maximum": 3600
},
"title": {
"type": "string",
"maxLength": 200
},
"limit": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
}
}
}
},
"required": [
"id",
"type",
"gridPos",
"props"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"type": {
"type": "string",
"const": "inbox_preview"
},
"gridPos": {
"type": "object",
"properties": {
"x": {
"type": "integer",
"minimum": 0,
"maximum": 11
},
"y": {
"type": "integer",
"minimum": 0,
"maximum": 1000
},
"w": {
"type": "integer",
"minimum": 1,
"maximum": 12
},
"h": {
"type": "integer",
"minimum": 1,
"maximum": 20
}
},
"required": [
"x",
"y",
"w",
"h"
]
},
"visible": {
"default": true,
"type": "boolean"
},
"props": {
"type": "object",
"properties": {
"refreshSeconds": {
"default": 30,
"type": "integer",
"minimum": 5,
"maximum": 3600
},
"title": {
"type": "string",
"maxLength": 200
},
"limit": {
"default": 5,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"label": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
}
}
},
"required": [
"id",
"type",
"gridPos",
"props"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"type": {
"type": "string",
"const": "agent_log"
},
"gridPos": {
"type": "object",
"properties": {
"x": {
"type": "integer",
"minimum": 0,
"maximum": 11
},
"y": {
"type": "integer",
"minimum": 0,
"maximum": 1000
},
"w": {
"type": "integer",
"minimum": 1,
"maximum": 12
},
"h": {
"type": "integer",
"minimum": 1,
"maximum": 20
}
},
"required": [
"x",
"y",
"w",
"h"
]
},
"visible": {
"default": true,
"type": "boolean"
},
"props": {
"type": "object",
"properties": {
"refreshSeconds": {
"default": 30,
"type": "integer",
"minimum": 5,
"maximum": 3600
},
"title": {
"type": "string",
"maxLength": 200
},
"limit": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
}
}
}
},
"required": [
"id",
"type",
"gridPos",
"props"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"type": {
"type": "string",
"const": "agent_note"
},
"gridPos": {
"type": "object",
"properties": {
"x": {
"type": "integer",
"minimum": 0,
"maximum": 11
},
"y": {
"type": "integer",
"minimum": 0,
"maximum": 1000
},
"w": {
"type": "integer",
"minimum": 1,
"maximum": 12
},
"h": {
"type": "integer",
"minimum": 1,
"maximum": 20
}
},
"required": [
"x",
"y",
"w",
"h"
]
},
"visible": {
"default": true,
"type": "boolean"
},
"props": {
"type": "object",
"properties": {
"refreshSeconds": {
"default": 30,
"type": "integer",
"minimum": 5,
"maximum": 3600
},
"title": {
"type": "string",
"maxLength": 200
},
"markdown": {
"default": "",
"type": "string",
"maxLength": 10000
}
}
}
},
"required": [
"id",
"type",
"gridPos",
"props"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"type": {
"type": "string",
"const": "quota_usage"
},
"gridPos": {
"type": "object",
"properties": {
"x": {
"type": "integer",
"minimum": 0,
"maximum": 11
},
"y": {
"type": "integer",
"minimum": 0,
"maximum": 1000
},
"w": {
"type": "integer",
"minimum": 1,
"maximum": 12
},
"h": {
"type": "integer",
"minimum": 1,
"maximum": 20
}
},
"required": [
"x",
"y",
"w",
"h"
]
},
"visible": {
"default": true,
"type": "boolean"
},
"props": {
"type": "object",
"properties": {
"refreshSeconds": {
"default": 30,
"type": "integer",
"minimum": 5,
"maximum": 3600
},
"title": {
"type": "string",
"maxLength": 200
}
}
}
},
"required": [
"id",
"type",
"gridPos",
"props"
]
}
]
}
}
},
"required": [
"schemaVersion",
"widgets"
]
},
"note": {
"description": "Optional human-readable note recorded alongside this edit (edited_by_note).",
"type": "string",
"maxLength": 2000
}
},
"required": [
"action"
],
"$schema": "http://json-schema.org/draft-07/schema#"
}