# MCP tool reference 1 callable tools. Use tools/call at https://mcp.schedulerzero.com/mcp with the exact tool name and arguments below. The /tools/ paths in this view are documentation identifiers, not HTTP endpoints. Request execution is disabled for this reference. Inputs are shown for personal API keys (bound) and for OAuth/delegated agents. Output schemas describe MCP structuredContent: native objects pass through; arrays, scalars and null use a data wrapper. Text content retains the native JSON result. [Connect a client](/mcp/connect) · [Authentication and authorization](/authentication) · [Generated auth guide](/auth.md) · [Download tool catalog](/mcp-catalog.json) · [Agent documentation](/llms.txt) ## read_inbox_health Reads workspace inboxes, aggregate stats, per-inbox row stats, analytics, recent-health alerts, deliverability state, placement runs, and subscription targets. Choose action for one native read; use batch_row_stats for up to 100 visible inbox IDs; omit it for a paginated inbox list plus aggregate stats. Filters apply only to the list; stats cover the Workspace. Use returned pagination for further pages. When the caller wants to mutate settings or dispatch work. Scopes: inbox:read, analytics:read, unibox:read Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "overview" ] }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "search": { "$ref": "#/$defs/ShortText" }, "sortBy": { "type": "string", "enum": [ "emailAddress", "status", "dailySendingLimit", "createdAt", "updatedAt" ] }, "sortOrder": { "type": "string", "enum": [ "asc", "desc" ] }, "provider": { "type": "string", "enum": [ "all", "google_workspace", "microsoft_365", "other" ] }, "statuses": { "$ref": "#/$defs/ShortText" }, "tagIds": { "$ref": "#/$defs/ShortText" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|action|offset|limit|search|sortBy|sortOrder|provider|statuses|tagIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "offset", "limit", "search", "sortBy", "sortOrder", "provider", "statuses", "tagIds" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "list" ] }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "search": { "$ref": "#/$defs/ShortText" }, "sortBy": { "type": "string", "enum": [ "emailAddress", "status", "dailySendingLimit", "createdAt", "updatedAt" ] }, "sortOrder": { "type": "string", "enum": [ "asc", "desc" ] }, "provider": { "type": "string", "enum": [ "all", "google_workspace", "microsoft_365", "other" ] }, "statuses": { "$ref": "#/$defs/ShortText" }, "tagIds": { "$ref": "#/$defs/ShortText" } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|offset|limit|search|sortBy|sortOrder|provider|statuses|tagIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "offset", "limit", "search", "sortBy", "sortOrder", "provider", "statuses", "tagIds" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "stats" ] } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "row_stats" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "batch_row_stats" ] }, "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 } }, "required": [ "workspaceId", "action", "inboxIds" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxIds" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "account_analytics" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "startDate": { "$ref": "#/$defs/LocalDate" }, "endDate": { "$ref": "#/$defs/LocalDate" }, "recipientProviders": { "$ref": "#/$defs/ShortText" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId|startDate|endDate|recipientProviders)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "startDate", "endDate", "recipientProviders" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "warmup_analytics" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "startDate": { "$ref": "#/$defs/LocalDate" }, "endDate": { "$ref": "#/$defs/LocalDate" }, "issuePage": { "type": "integer", "minimum": 1 }, "issuePageSize": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId|startDate|endDate|issuePage|issuePageSize)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "startDate", "endDate", "issuePage", "issuePageSize" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "recent_health" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "subscription_targets" ] } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "dns_status" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "settings" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "deliverability" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "placement_diagnostics" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "export" ] }, "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 500 } }, "required": [ "workspaceId", "action", "inboxIds" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxIds" ] } } ], "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "LocalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "workspaceId": { "type": "string", "format": "uuid", "description": "Target Workspace UUID. Call list_workspaces to enumerate the Workspaces this credential may access, then pass the chosen id here." } }, "required": [ "workspaceId" ], "anyOf": [ { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "overview" ] }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "search": { "$ref": "#/$defs/ShortText" }, "sortBy": { "type": "string", "enum": [ "emailAddress", "status", "dailySendingLimit", "createdAt", "updatedAt" ] }, "sortOrder": { "type": "string", "enum": [ "asc", "desc" ] }, "provider": { "type": "string", "enum": [ "all", "google_workspace", "microsoft_365", "other" ] }, "statuses": { "$ref": "#/$defs/ShortText" }, "tagIds": { "$ref": "#/$defs/ShortText" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|offset|limit|search|sortBy|sortOrder|provider|statuses|tagIds)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "offset", "limit", "search", "sortBy", "sortOrder", "provider", "statuses", "tagIds" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "list" ] }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "search": { "$ref": "#/$defs/ShortText" }, "sortBy": { "type": "string", "enum": [ "emailAddress", "status", "dailySendingLimit", "createdAt", "updatedAt" ] }, "sortOrder": { "type": "string", "enum": [ "asc", "desc" ] }, "provider": { "type": "string", "enum": [ "all", "google_workspace", "microsoft_365", "other" ] }, "statuses": { "$ref": "#/$defs/ShortText" }, "tagIds": { "$ref": "#/$defs/ShortText" } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|offset|limit|search|sortBy|sortOrder|provider|statuses|tagIds)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "offset", "limit", "search", "sortBy", "sortOrder", "provider", "statuses", "tagIds" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "stats" ] } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "row_stats" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "batch_row_stats" ] }, "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 } }, "required": [ "workspaceId", "action", "inboxIds" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxIds)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxIds" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "account_analytics" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "startDate": { "$ref": "#/$defs/LocalDate" }, "endDate": { "$ref": "#/$defs/LocalDate" }, "recipientProviders": { "$ref": "#/$defs/ShortText" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId|startDate|endDate|recipientProviders)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "startDate", "endDate", "recipientProviders" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "warmup_analytics" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "startDate": { "$ref": "#/$defs/LocalDate" }, "endDate": { "$ref": "#/$defs/LocalDate" }, "issuePage": { "type": "integer", "minimum": 1 }, "issuePageSize": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId|startDate|endDate|issuePage|issuePageSize)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "startDate", "endDate", "issuePage", "issuePageSize" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "recent_health" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "subscription_targets" ] } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "dns_status" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "settings" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "deliverability" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "placement_diagnostics" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "export" ] }, "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 500 } }, "required": [ "workspaceId", "action", "inboxIds" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxIds)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxIds" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "LocalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "LeadStoredText": { "type": "string", "maxLength": 65536 }, "HexColor": { "type": "string", "pattern": "^#[0-9A-Fa-f]{6}$" }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "LocalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "DomainName": { "type": "string", "minLength": 1, "maxLength": 253, "pattern": "^(?=.{1,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "inboxes": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "status": { "type": "string", "enum": [ "active", "inactive", "error", "alert" ] }, "statusDetail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "dailySendingLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "minGapSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupEnabled": { "type": "boolean" }, "warmupReputationScore": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "color", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|color|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color", "description", "createdAt", "updatedAt" ] } } }, "deliveryStatus": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "ok", "degraded", "blocked", "unknown" ] }, "detail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "state", "detail" ], "patternProperties": { "^(?!(?:state|detail)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "state", "detail" ] } }, "dnsRecords": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "emailAddress", "provider", "status", "statusDetail", "createdAt", "updatedAt", "senderFirstName", "senderLastName", "dailySendingLimit", "minGapSeconds", "warmupEnabled", "warmupReputationScore", "tags", "deliveryStatus" ], "patternProperties": { "^(?!(?:id|emailAddress|provider|status|statusDetail|createdAt|updatedAt|senderFirstName|senderLastName|dailySendingLimit|minGapSeconds|warmupEnabled|warmupReputationScore|tags|deliveryStatus|dnsRecords|recipientBounceCount|senderBounceCount|unclassifiedBounceCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "provider", "status", "statusDetail", "createdAt", "updatedAt", "senderFirstName", "senderLastName", "dailySendingLimit", "minGapSeconds", "warmupEnabled", "warmupReputationScore", "tags", "deliveryStatus", "dnsRecords", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount" ] } } }, "pagination": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPages": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currentPage": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasNextPage": { "type": "boolean" }, "hasPreviousPage": { "type": "boolean" } }, "required": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ], "patternProperties": { "^(?!(?:total|totalPages|currentPage|pageSize|offset|hasNextPage|hasPreviousPage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, "stats": { "type": "object", "properties": { "totalInboxes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalDomains": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "errorCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "alertCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "totalInboxes", "totalDomains", "warmupCount", "errorCount", "alertCount" ], "patternProperties": { "^(?!(?:totalInboxes|totalDomains|warmupCount|errorCount|alertCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "totalInboxes", "totalDomains", "warmupCount", "errorCount", "alertCount" ] } } }, "required": [ "inboxes", "stats" ], "patternProperties": { "^(?!(?:inboxes|stats)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxes", "stats" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "status": { "type": "string", "enum": [ "active", "inactive", "error", "alert" ] }, "statusDetail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "dailySendingLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "minGapSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupEnabled": { "type": "boolean" }, "warmupReputationScore": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "color", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|color|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color", "description", "createdAt", "updatedAt" ] } } }, "deliveryStatus": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "ok", "degraded", "blocked", "unknown" ] }, "detail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "state", "detail" ], "patternProperties": { "^(?!(?:state|detail)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "state", "detail" ] } }, "dnsRecords": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "emailAddress", "provider", "status", "statusDetail", "createdAt", "updatedAt", "senderFirstName", "senderLastName", "dailySendingLimit", "minGapSeconds", "warmupEnabled", "warmupReputationScore", "tags", "deliveryStatus" ], "patternProperties": { "^(?!(?:id|emailAddress|provider|status|statusDetail|createdAt|updatedAt|senderFirstName|senderLastName|dailySendingLimit|minGapSeconds|warmupEnabled|warmupReputationScore|tags|deliveryStatus|dnsRecords|recipientBounceCount|senderBounceCount|unclassifiedBounceCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "provider", "status", "statusDetail", "createdAt", "updatedAt", "senderFirstName", "senderLastName", "dailySendingLimit", "minGapSeconds", "warmupEnabled", "warmupReputationScore", "tags", "deliveryStatus", "dnsRecords", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount" ] } } }, "pagination": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPages": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currentPage": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasNextPage": { "type": "boolean" }, "hasPreviousPage": { "type": "boolean" } }, "required": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ], "patternProperties": { "^(?!(?:total|totalPages|currentPage|pageSize|offset|hasNextPage|hasPreviousPage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "type": "object", "properties": { "totalInboxes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalDomains": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "errorCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "alertCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "totalInboxes", "totalDomains", "warmupCount", "errorCount", "alertCount" ], "patternProperties": { "^(?!(?:totalInboxes|totalDomains|warmupCount|errorCount|alertCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "totalInboxes", "totalDomains", "warmupCount", "errorCount", "alertCount" ] } }, { "type": "object", "properties": { "dailySentEmails": { "$ref": "#/$defs/ShortText" }, "sendLimitToday": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sendLimitTarget": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "sendRampDaysRemaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalWarmupEmails": { "$ref": "#/$defs/ShortText" }, "initialWarmupEmails": { "$ref": "#/$defs/ShortText" }, "warmupLimitToday": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupLimitTarget": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupRampDaysRemaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupEmailDeliverability": { "$ref": "#/$defs/ShortText" }, "replyRate": { "$ref": "#/$defs/ShortText" }, "totalCampaigns": { "$ref": "#/$defs/ShortText" } }, "required": [ "dailySentEmails", "sendLimitToday", "sendLimitTarget", "sendRampDaysRemaining", "totalWarmupEmails", "initialWarmupEmails", "warmupLimitToday", "warmupLimitTarget", "warmupRampDaysRemaining", "warmupEmailDeliverability", "replyRate", "totalCampaigns" ], "patternProperties": { "^(?!(?:dailySentEmails|sendLimitToday|sendLimitTarget|sendRampDaysRemaining|totalWarmupEmails|initialWarmupEmails|warmupLimitToday|warmupLimitTarget|warmupRampDaysRemaining|warmupEmailDeliverability|replyRate|totalCampaigns)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dailySentEmails", "sendLimitToday", "sendLimitTarget", "sendRampDaysRemaining", "totalWarmupEmails", "initialWarmupEmails", "warmupLimitToday", "warmupLimitTarget", "warmupRampDaysRemaining", "warmupEmailDeliverability", "replyRate", "totalCampaigns" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "stats": { "type": "object", "properties": { "dailySentEmails": { "$ref": "#/$defs/ShortText" }, "sendLimitToday": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sendLimitTarget": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "sendRampDaysRemaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalWarmupEmails": { "$ref": "#/$defs/ShortText" }, "initialWarmupEmails": { "$ref": "#/$defs/ShortText" }, "warmupLimitToday": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupLimitTarget": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupRampDaysRemaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupEmailDeliverability": { "$ref": "#/$defs/ShortText" }, "replyRate": { "$ref": "#/$defs/ShortText" }, "totalCampaigns": { "$ref": "#/$defs/ShortText" } }, "required": [ "dailySentEmails", "sendLimitToday", "sendLimitTarget", "sendRampDaysRemaining", "totalWarmupEmails", "initialWarmupEmails", "warmupLimitToday", "warmupLimitTarget", "warmupRampDaysRemaining", "warmupEmailDeliverability", "replyRate", "totalCampaigns" ], "patternProperties": { "^(?!(?:dailySentEmails|sendLimitToday|sendLimitTarget|sendRampDaysRemaining|totalWarmupEmails|initialWarmupEmails|warmupLimitToday|warmupLimitTarget|warmupRampDaysRemaining|warmupEmailDeliverability|replyRate|totalCampaigns)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dailySentEmails", "sendLimitToday", "sendLimitTarget", "sendRampDaysRemaining", "totalWarmupEmails", "initialWarmupEmails", "warmupLimitToday", "warmupLimitTarget", "warmupRampDaysRemaining", "warmupEmailDeliverability", "replyRate", "totalCampaigns" ] } } }, "required": [ "inboxId", "stats" ], "patternProperties": { "^(?!(?:inboxId|stats)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxId", "stats" ] } }, "maxItems": 100 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "summary": { "type": "object", "properties": { "totalLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "leadsContacted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "leadsContactedPercentage": { "type": "number" }, "totalEmailsSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCountWithOOO": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyRate": { "type": "number" }, "replyRateWithOOO": { "type": "number" }, "positiveReplyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "positiveReplyRate": { "type": "number" }, "bounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceRate": { "type": "number" }, "newLeadsContacted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalCompletedLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "totalLeads", "leadsContacted", "leadsContactedPercentage", "totalEmailsSent", "replyCount", "replyCountWithOOO", "replyRate", "replyRateWithOOO", "positiveReplyCount", "positiveReplyRate", "bounceCount", "bounceRate", "newLeadsContacted", "totalCompletedLeads" ], "patternProperties": { "^(?!(?:totalLeads|leadsContacted|leadsContactedPercentage|totalEmailsSent|replyCount|replyCountWithOOO|replyRate|replyRateWithOOO|positiveReplyCount|positiveReplyRate|bounceCount|bounceRate|newLeadsContacted|totalCompletedLeads|recipientBounceCount|senderBounceCount|unclassifiedBounceCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "totalLeads", "leadsContacted", "leadsContactedPercentage", "totalEmailsSent", "replyCount", "replyCountWithOOO", "replyRate", "replyRateWithOOO", "positiveReplyCount", "positiveReplyRate", "bounceCount", "bounceRate", "newLeadsContacted", "totalCompletedLeads", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount" ] } }, "dailyEmailSent": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "newLead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "followUp": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "newLead", "followUp" ], "patternProperties": { "^(?!(?:date|newLead|followUp)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "newLead", "followUp" ] } } }, "dailyMetrics": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "replyCountWithOOO": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "positiveReplyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "replyCountWithOOO", "replyCount", "positiveReplyCount", "bounceCount" ], "patternProperties": { "^(?!(?:date|replyCountWithOOO|replyCount|positiveReplyCount|bounceCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "replyCountWithOOO", "replyCount", "positiveReplyCount", "bounceCount" ] } } } }, "required": [ "summary", "dailyEmailSent", "dailyMetrics" ], "patternProperties": { "^(?!(?:summary|dailyEmailSent|dailyMetrics)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "dailyEmailSent", "dailyMetrics" ] } }, { "type": "object", "properties": { "summary": { "type": "object", "properties": { "receivedBySeeds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupEmailsSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sentByUs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "neverArrived": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "awaitingConfirmation": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "landedInInbox": { "type": "number" }, "landedInInboxCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "landedInSpam": { "type": "number" }, "landedInSpamCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "landedInTabs": { "type": "number" }, "landedInTabsCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "followUp": { "type": "object", "properties": { "windowMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "eligible": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "observed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tabs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unavailable": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pending": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "spamRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "tabsRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "windowMinutes", "eligible", "observed", "inbox", "spam", "tabs", "unavailable", "pending", "inboxRate", "spamRate", "tabsRate" ], "patternProperties": { "^(?!(?:windowMinutes|eligible|observed|inbox|spam|tabs|unavailable|pending|inboxRate|spamRate|tabsRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "windowMinutes", "eligible", "observed", "inbox", "spam", "tabs", "unavailable", "pending", "inboxRate", "spamRate", "tabsRate" ] } }, "bouncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "seedReplies": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "receivedBySeeds", "warmupEmailsSent", "sentByUs", "neverArrived", "awaitingConfirmation", "landedInInbox", "landedInInboxCount", "landedInSpam", "landedInSpamCount", "landedInTabs", "landedInTabsCount", "followUp", "bouncedCount", "seedReplies" ], "patternProperties": { "^(?!(?:receivedBySeeds|warmupEmailsSent|sentByUs|neverArrived|awaitingConfirmation|landedInInbox|landedInInboxCount|landedInSpam|landedInSpamCount|landedInTabs|landedInTabsCount|followUp|bouncedCount|seedReplies)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "receivedBySeeds", "warmupEmailsSent", "sentByUs", "neverArrived", "awaitingConfirmation", "landedInInbox", "landedInInboxCount", "landedInSpam", "landedInSpamCount", "landedInTabs", "landedInTabsCount", "followUp", "bouncedCount", "seedReplies" ] } }, "dailyDeliverability": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "received": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tabs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "followUpEligible": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "followUpUnavailable": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "sent", "received", "inbox", "spam", "tabs", "followUpEligible", "followUpUnavailable" ], "patternProperties": { "^(?!(?:date|sent|received|inbox|spam|tabs|followUpEligible|followUpUnavailable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "sent", "received", "inbox", "spam", "tabs", "followUpEligible", "followUpUnavailable" ] } } }, "placementByProvider": { "type": "array", "items": { "type": "object", "properties": { "provider": { "$ref": "#/$defs/ShortText" }, "received": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tabs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxRate": { "type": "number" }, "spamRate": { "type": "number" }, "tabsRate": { "type": "number" } }, "required": [ "provider", "received", "inbox", "spam", "tabs", "inboxRate", "spamRate", "tabsRate" ], "patternProperties": { "^(?!(?:provider|received|inbox|spam|tabs|inboxRate|spamRate|tabsRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "received", "inbox", "spam", "tabs", "inboxRate", "spamRate", "tabsRate" ] } } }, "sevenDayEngagement": { "type": "object", "properties": { "window": { "type": "object", "properties": { "from": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "to": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "hours": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "from", "to", "hours" ], "patternProperties": { "^(?!(?:from|to|hours)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "from", "to", "hours" ] } }, "pool": { "anyOf": [ { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "name": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } }, { "type": "null" } ] }, "desired": { "$ref": "#/$defs/Union_" }, "applied": { "type": "array", "items": { "type": "object", "properties": { "providerId": { "$ref": "#/$defs/ShortText" }, "status": { "$ref": "#/$defs/ShortText" }, "desiredPolicy": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "appliedPolicy": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "unsupportedControls": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "lastSyncAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastSyncError": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "providerId", "status", "desiredPolicy", "appliedPolicy", "unsupportedControls", "lastSyncAt", "lastSyncError" ], "patternProperties": { "^(?!(?:providerId|status|desiredPolicy|appliedPolicy|unsupportedControls|lastSyncAt|lastSyncError)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "providerId", "status", "desiredPolicy", "appliedPolicy", "unsupportedControls", "lastSyncAt", "lastSyncError" ] } } }, "observed": { "type": "object", "properties": { "composition": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "html": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rate": { "type": "number" } }, "required": [ "count", "rate" ], "patternProperties": { "^(?!(?:count|rate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "count", "rate" ] } }, "tracked": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "eligible": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rate": { "type": "number" } }, "required": [ "count", "eligible", "rate" ], "patternProperties": { "^(?!(?:count|eligible|rate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "count", "eligible", "rate" ] } }, "signed": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "eligible": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rate": { "type": "number" } }, "required": [ "count", "eligible", "rate" ], "patternProperties": { "^(?!(?:count|eligible|rate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "count", "eligible", "rate" ] } } }, "required": [ "total", "html", "tracked", "signed" ], "patternProperties": { "^(?!(?:total|html|tracked|signed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "html", "tracked", "signed" ] } }, "warmupip": { "type": "object", "properties": { "delivered": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "opens": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "clicks": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "openRate": { "type": "number" }, "clickRate": { "type": "number" } }, "required": [ "delivered", "opens", "clicks", "openRate", "clickRate" ], "patternProperties": { "^(?!(?:delivered|opens|clicks|openRate|clickRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "delivered", "opens", "clicks", "openRate", "clickRate" ] } }, "internalMesh": { "type": "object", "properties": { "delivered": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "read": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "clicked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replied": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "important": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rescuedFromSpam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "delivered", "read", "clicked", "replied", "important", "rescuedFromSpam" ], "patternProperties": { "^(?!(?:delivered|read|clicked|replied|important|rescuedFromSpam)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "delivered", "read", "clicked", "replied", "important", "rescuedFromSpam" ] } }, "localTracking": { "type": "object", "properties": { "opens": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "clicks": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rawOpens": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rawClicks": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "opens", "clicks", "rawOpens", "rawClicks" ], "patternProperties": { "^(?!(?:opens|clicks|rawOpens|rawClicks)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "opens", "clicks", "rawOpens", "rawClicks" ] } } }, "required": [ "composition", "warmupip", "internalMesh", "localTracking" ], "patternProperties": { "^(?!(?:composition|warmupip|internalMesh|localTracking)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "composition", "warmupip", "internalMesh", "localTracking" ] } } }, "required": [ "window", "pool", "desired", "applied", "observed" ], "patternProperties": { "^(?!(?:window|pool|desired|applied|observed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "window", "pool", "desired", "applied", "observed" ] } }, "deliveryIssues": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "bounced", "failed" ] }, "receiverEmail": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "reason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "occurredAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "status", "receiverEmail", "reason", "occurredAt" ], "patternProperties": { "^(?!(?:status|receiverEmail|reason|occurredAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "receiverEmail", "reason", "occurredAt" ] } } }, "deliveryIssuesPagination": { "type": "object", "properties": { "page": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPages": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "page", "pageSize", "total", "totalPages" ], "patternProperties": { "^(?!(?:page|pageSize|total|totalPages)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "page", "pageSize", "total", "totalPages" ] } } }, "required": [ "summary", "dailyDeliverability", "placementByProvider", "sevenDayEngagement", "deliveryIssues", "deliveryIssuesPagination" ], "patternProperties": { "^(?!(?:summary|dailyDeliverability|placementByProvider|sevenDayEngagement|deliveryIssues|deliveryIssuesPagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "dailyDeliverability", "placementByProvider", "sevenDayEngagement", "deliveryIssues", "deliveryIssuesPagination" ] } }, { "type": "object", "properties": { "windows": { "type": "object", "properties": { "evaluatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "bounceRecentStart": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "bouncePreviousStart": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "replyRecentEnd": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "replyRecentStart": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "replyPreviousStart": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "evaluatedAt", "bounceRecentStart", "bouncePreviousStart", "replyRecentEnd", "replyRecentStart", "replyPreviousStart" ], "patternProperties": { "^(?!(?:evaluatedAt|bounceRecentStart|bouncePreviousStart|replyRecentEnd|replyRecentStart|replyPreviousStart)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "evaluatedAt", "bounceRecentStart", "bouncePreviousStart", "replyRecentEnd", "replyRecentStart", "replyPreviousStart" ] } }, "policy": { "type": "object", "properties": { "windowDays": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyObservationHours": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "minBounceSends": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "minBounces": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceRatePercent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceIncreasePoints": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "minReplyContacts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "windowDays", "replyObservationHours", "minBounceSends", "minBounces", "bounceRatePercent", "bounceIncreasePoints", "minReplyContacts" ], "patternProperties": { "^(?!(?:windowDays|replyObservationHours|minBounceSends|minBounces|bounceRatePercent|bounceIncreasePoints|minReplyContacts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "windowDays", "replyObservationHours", "minBounceSends", "minBounces", "bounceRatePercent", "bounceIncreasePoints", "minReplyContacts" ] } }, "alerts": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/ShortText" }, "scope": { "type": "string", "enum": [ "inbox", "domain" ] }, "key": { "$ref": "#/$defs/ShortText" }, "label": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "code": { "type": "string", "enum": [ "high_bounce_rate", "bounce_rate_increase", "reply_rate_drop" ] }, "title": { "$ref": "#/$defs/ShortText" }, "description": { "$ref": "#/$defs/ShortText" }, "recommendation": { "$ref": "#/$defs/ShortText" }, "recent": { "type": "object", "properties": { "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contacts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replied": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "sent", "bounced", "contacts", "replied" ], "patternProperties": { "^(?!(?:sent|bounced|contacts|replied)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "sent", "bounced", "contacts", "replied" ] } }, "previous": { "type": "object", "properties": { "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contacts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replied": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "sent", "bounced", "contacts", "replied" ], "patternProperties": { "^(?!(?:sent|bounced|contacts|replied)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "sent", "bounced", "contacts", "replied" ] } } }, "required": [ "id", "scope", "key", "label", "code", "title", "description", "recommendation", "recent", "previous" ], "patternProperties": { "^(?!(?:id|scope|key|label|code|title|description|recommendation|recent|previous)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "scope", "key", "label", "code", "title", "description", "recommendation", "recent", "previous" ] } }, "maxItems": 100 }, "totalAlerts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "evaluatedScopes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "insufficientBounceSamples": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "insufficientReplySamples": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "windows", "policy", "alerts", "totalAlerts", "evaluatedScopes", "insufficientBounceSamples", "insufficientReplySamples" ], "patternProperties": { "^(?!(?:windows|policy|alerts|totalAlerts|evaluatedScopes|insufficientBounceSamples|insufficientReplySamples)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "windows", "policy", "alerts", "totalAlerts", "evaluatedScopes", "insufficientBounceSamples", "insufficientReplySamples" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "status": { "type": "string", "enum": [ "active", "inactive", "error", "alert" ] }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] } }, "required": [ "id", "emailAddress", "status", "provider" ], "patternProperties": { "^(?!(?:id|emailAddress|status|provider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "status", "provider" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "state": { "type": "string", "enum": [ "idle", "running", "completed", "failed" ] }, "runId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "step": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "progress": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "records": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "state", "runId", "step", "progress", "records", "error" ], "patternProperties": { "^(?!(?:state|runId|step|progress|records|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "state", "runId", "step", "progress", "records", "error" ] } }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderReplyTo": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "autoBcc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "autoCc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "dailySendingLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "minGapSeconds": { "anyOf": [ { "type": "integer", "minimum": 120, "maximum": 21600 }, { "type": "null" } ] }, "initialDailyLimit": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 100 }, { "type": "null" } ] }, "dailyIncrement": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50 }, { "type": "null" } ] }, "campaignEmailRampUp": { "type": "boolean" }, "signature": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "customVariables": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[a-z][a-z0-9_]*$" }, "value": { "type": "string", "minLength": 1, "maxLength": 10000 } }, "required": [ "key", "value" ], "patternProperties": { "^(?!(?:key|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "key", "value" ] } }, "maxItems": 50 }, "customTrackingDomain": { "anyOf": [ { "$ref": "#/$defs/DomainName" }, { "type": "null" } ] }, "customTrackingDomainVerified": { "type": "boolean" }, "syncNonCampaignEmails": { "type": "boolean" }, "isPlacementTestRecipient": { "type": "boolean" }, "canSyncNonCampaignEmails": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "color", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|color|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color", "description", "createdAt", "updatedAt" ] } } } }, "required": [ "id", "emailAddress", "senderFirstName", "senderLastName", "senderReplyTo", "autoBcc", "autoCc", "dailySendingLimit", "minGapSeconds", "initialDailyLimit", "dailyIncrement", "campaignEmailRampUp", "signature", "customVariables", "customTrackingDomain", "customTrackingDomainVerified", "syncNonCampaignEmails", "isPlacementTestRecipient", "canSyncNonCampaignEmails", "tags" ], "patternProperties": { "^(?!(?:id|emailAddress|senderFirstName|senderLastName|senderReplyTo|autoBcc|autoCc|dailySendingLimit|minGapSeconds|initialDailyLimit|dailyIncrement|campaignEmailRampUp|signature|customVariables|customTrackingDomain|customTrackingDomainVerified|syncNonCampaignEmails|isPlacementTestRecipient|canSyncNonCampaignEmails|tags)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "senderFirstName", "senderLastName", "senderReplyTo", "autoBcc", "autoCc", "dailySendingLimit", "minGapSeconds", "initialDailyLimit", "dailyIncrement", "campaignEmailRampUp", "signature", "customVariables", "customTrackingDomain", "customTrackingDomainVerified", "syncNonCampaignEmails", "isPlacementTestRecipient", "canSyncNonCampaignEmails", "tags" ] } }, { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "hetrixtools" ] }, "monitoredValues": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "run": { "type": "object", "properties": { "runId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "state": { "type": "string", "enum": [ "idle", "running", "completed", "failed" ] } }, "required": [ "runId", "state" ], "patternProperties": { "^(?!(?:runId|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "runId", "state" ] } }, "assets": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "kind": { "type": "string", "enum": [ "sending_domain", "tracking_domain" ] }, "value": { "$ref": "#/$defs/ShortText" }, "provider": { "$ref": "#/$defs/ShortText" }, "lastCheckStatus": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "lastCheckedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "checkedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "listedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warningCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "timeoutCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastError": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "listings": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "assetId": { "$ref": "#/$defs/OpaqueId" }, "listName": { "$ref": "#/$defs/ShortText" }, "info": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "detailUrl": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "firstListedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastSeenListedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "assetId", "listName", "info", "detailUrl", "firstListedAt", "lastSeenListedAt" ], "patternProperties": { "^(?!(?:id|assetId|listName|info|detailUrl|firstListedAt|lastSeenListedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "assetId", "listName", "info", "detailUrl", "firstListedAt", "lastSeenListedAt" ] } } } }, "required": [ "id", "kind", "value", "provider", "lastCheckStatus", "lastCheckedAt", "checkedCount", "listedCount", "warningCount", "timeoutCount", "lastError", "listings" ], "patternProperties": { "^(?!(?:id|kind|value|provider|lastCheckStatus|lastCheckedAt|checkedCount|listedCount|warningCount|timeoutCount|lastError|listings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "value", "provider", "lastCheckStatus", "lastCheckedAt", "checkedCount", "listedCount", "warningCount", "timeoutCount", "lastError", "listings" ] } } } }, "required": [ "provider", "monitoredValues", "run", "assets" ], "patternProperties": { "^(?!(?:provider|monitoredValues|run|assets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "monitoredValues", "run", "assets" ] } }, { "type": "object", "properties": { "recipients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] } }, "required": [ "id", "emailAddress", "provider" ], "patternProperties": { "^(?!(?:id|emailAddress|provider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "provider" ] } } }, "tests": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "recipientInboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "subject": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "pending", "sending", "observing", "completed", "failed", "send_uncertain" ] }, "sentAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "errorMessage": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "observations": { "type": "array", "items": { "type": "object", "properties": { "checkpointSeconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "placement": { "type": "string", "enum": [ "inbox", "tabs", "spam", "other", "not_found", "error" ] }, "isRead": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "errorMessage": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "observedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "checkpointSeconds", "placement", "isRead", "errorMessage", "observedAt" ], "patternProperties": { "^(?!(?:checkpointSeconds|placement|isRead|errorMessage|observedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "checkpointSeconds", "placement", "isRead", "errorMessage", "observedAt" ] } } } }, "required": [ "id", "recipientInboxId", "subject", "status", "sentAt", "createdAt", "errorMessage", "observations" ], "patternProperties": { "^(?!(?:id|recipientInboxId|subject|status|sentAt|createdAt|errorMessage|observations)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "recipientInboxId", "subject", "status", "sentAt", "createdAt", "errorMessage", "observations" ] } } } }, "required": [ "recipients", "tests" ], "patternProperties": { "^(?!(?:recipients|tests)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "recipients", "tests" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "status": { "type": "string", "enum": [ "active", "inactive", "error", "alert" ] }, "statusDetail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "dailySendingLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "minGapSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupEnabled": { "type": "boolean" }, "dailyWarmupLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "tags": { "$ref": "#/$defs/ShortText" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "emailAddress", "provider", "status", "statusDetail", "dailySendingLimit", "minGapSeconds", "warmupEnabled", "dailyWarmupLimit", "tags", "createdAt" ], "patternProperties": { "^(?!(?:emailAddress|provider|status|statusDetail|dailySendingLimit|minGapSeconds|warmupEnabled|dailyWarmupLimit|tags|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "emailAddress", "provider", "status", "statusDetail", "dailySendingLimit", "minGapSeconds", "warmupEnabled", "dailyWarmupLimit", "tags", "createdAt" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "inboxes": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "status": { "type": "string", "enum": [ "active", "inactive", "error", "alert" ] }, "statusDetail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "dailySendingLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "minGapSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupEnabled": { "type": "boolean" }, "warmupReputationScore": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "color", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|color|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color", "description", "createdAt", "updatedAt" ] } } }, "deliveryStatus": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "ok", "degraded", "blocked", "unknown" ] }, "detail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "state", "detail" ], "patternProperties": { "^(?!(?:state|detail)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "state", "detail" ] } }, "dnsRecords": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "emailAddress", "provider", "status", "statusDetail", "createdAt", "updatedAt", "senderFirstName", "senderLastName", "dailySendingLimit", "minGapSeconds", "warmupEnabled", "warmupReputationScore", "tags", "deliveryStatus" ], "patternProperties": { "^(?!(?:id|emailAddress|provider|status|statusDetail|createdAt|updatedAt|senderFirstName|senderLastName|dailySendingLimit|minGapSeconds|warmupEnabled|warmupReputationScore|tags|deliveryStatus|dnsRecords|recipientBounceCount|senderBounceCount|unclassifiedBounceCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "provider", "status", "statusDetail", "createdAt", "updatedAt", "senderFirstName", "senderLastName", "dailySendingLimit", "minGapSeconds", "warmupEnabled", "warmupReputationScore", "tags", "deliveryStatus", "dnsRecords", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount" ] } } }, "pagination": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPages": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currentPage": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasNextPage": { "type": "boolean" }, "hasPreviousPage": { "type": "boolean" } }, "required": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ], "patternProperties": { "^(?!(?:total|totalPages|currentPage|pageSize|offset|hasNextPage|hasPreviousPage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, "stats": { "type": "object", "properties": { "totalInboxes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalDomains": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "errorCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "alertCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "totalInboxes", "totalDomains", "warmupCount", "errorCount", "alertCount" ], "patternProperties": { "^(?!(?:totalInboxes|totalDomains|warmupCount|errorCount|alertCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "totalInboxes", "totalDomains", "warmupCount", "errorCount", "alertCount" ] } } }, "required": [ "inboxes", "stats" ], "patternProperties": { "^(?!(?:inboxes|stats)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxes", "stats" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "status": { "type": "string", "enum": [ "active", "inactive", "error", "alert" ] }, "statusDetail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "dailySendingLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "minGapSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupEnabled": { "type": "boolean" }, "warmupReputationScore": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "color", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|color|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color", "description", "createdAt", "updatedAt" ] } } }, "deliveryStatus": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "ok", "degraded", "blocked", "unknown" ] }, "detail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "state", "detail" ], "patternProperties": { "^(?!(?:state|detail)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "state", "detail" ] } }, "dnsRecords": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "emailAddress", "provider", "status", "statusDetail", "createdAt", "updatedAt", "senderFirstName", "senderLastName", "dailySendingLimit", "minGapSeconds", "warmupEnabled", "warmupReputationScore", "tags", "deliveryStatus" ], "patternProperties": { "^(?!(?:id|emailAddress|provider|status|statusDetail|createdAt|updatedAt|senderFirstName|senderLastName|dailySendingLimit|minGapSeconds|warmupEnabled|warmupReputationScore|tags|deliveryStatus|dnsRecords|recipientBounceCount|senderBounceCount|unclassifiedBounceCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "provider", "status", "statusDetail", "createdAt", "updatedAt", "senderFirstName", "senderLastName", "dailySendingLimit", "minGapSeconds", "warmupEnabled", "warmupReputationScore", "tags", "deliveryStatus", "dnsRecords", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount" ] } } }, "pagination": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPages": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currentPage": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasNextPage": { "type": "boolean" }, "hasPreviousPage": { "type": "boolean" } }, "required": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ], "patternProperties": { "^(?!(?:total|totalPages|currentPage|pageSize|offset|hasNextPage|hasPreviousPage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "type": "object", "properties": { "totalInboxes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalDomains": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "errorCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "alertCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "totalInboxes", "totalDomains", "warmupCount", "errorCount", "alertCount" ], "patternProperties": { "^(?!(?:totalInboxes|totalDomains|warmupCount|errorCount|alertCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "totalInboxes", "totalDomains", "warmupCount", "errorCount", "alertCount" ] } }, { "type": "object", "properties": { "dailySentEmails": { "$ref": "#/$defs/ShortText" }, "sendLimitToday": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sendLimitTarget": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "sendRampDaysRemaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalWarmupEmails": { "$ref": "#/$defs/ShortText" }, "initialWarmupEmails": { "$ref": "#/$defs/ShortText" }, "warmupLimitToday": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupLimitTarget": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupRampDaysRemaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupEmailDeliverability": { "$ref": "#/$defs/ShortText" }, "replyRate": { "$ref": "#/$defs/ShortText" }, "totalCampaigns": { "$ref": "#/$defs/ShortText" } }, "required": [ "dailySentEmails", "sendLimitToday", "sendLimitTarget", "sendRampDaysRemaining", "totalWarmupEmails", "initialWarmupEmails", "warmupLimitToday", "warmupLimitTarget", "warmupRampDaysRemaining", "warmupEmailDeliverability", "replyRate", "totalCampaigns" ], "patternProperties": { "^(?!(?:dailySentEmails|sendLimitToday|sendLimitTarget|sendRampDaysRemaining|totalWarmupEmails|initialWarmupEmails|warmupLimitToday|warmupLimitTarget|warmupRampDaysRemaining|warmupEmailDeliverability|replyRate|totalCampaigns)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dailySentEmails", "sendLimitToday", "sendLimitTarget", "sendRampDaysRemaining", "totalWarmupEmails", "initialWarmupEmails", "warmupLimitToday", "warmupLimitTarget", "warmupRampDaysRemaining", "warmupEmailDeliverability", "replyRate", "totalCampaigns" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "stats": { "type": "object", "properties": { "dailySentEmails": { "$ref": "#/$defs/ShortText" }, "sendLimitToday": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sendLimitTarget": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "sendRampDaysRemaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalWarmupEmails": { "$ref": "#/$defs/ShortText" }, "initialWarmupEmails": { "$ref": "#/$defs/ShortText" }, "warmupLimitToday": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupLimitTarget": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupRampDaysRemaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupEmailDeliverability": { "$ref": "#/$defs/ShortText" }, "replyRate": { "$ref": "#/$defs/ShortText" }, "totalCampaigns": { "$ref": "#/$defs/ShortText" } }, "required": [ "dailySentEmails", "sendLimitToday", "sendLimitTarget", "sendRampDaysRemaining", "totalWarmupEmails", "initialWarmupEmails", "warmupLimitToday", "warmupLimitTarget", "warmupRampDaysRemaining", "warmupEmailDeliverability", "replyRate", "totalCampaigns" ], "patternProperties": { "^(?!(?:dailySentEmails|sendLimitToday|sendLimitTarget|sendRampDaysRemaining|totalWarmupEmails|initialWarmupEmails|warmupLimitToday|warmupLimitTarget|warmupRampDaysRemaining|warmupEmailDeliverability|replyRate|totalCampaigns)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dailySentEmails", "sendLimitToday", "sendLimitTarget", "sendRampDaysRemaining", "totalWarmupEmails", "initialWarmupEmails", "warmupLimitToday", "warmupLimitTarget", "warmupRampDaysRemaining", "warmupEmailDeliverability", "replyRate", "totalCampaigns" ] } } }, "required": [ "inboxId", "stats" ], "patternProperties": { "^(?!(?:inboxId|stats)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxId", "stats" ] } }, "maxItems": 100 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "summary": { "type": "object", "properties": { "totalLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "leadsContacted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "leadsContactedPercentage": { "type": "number" }, "totalEmailsSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCountWithOOO": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyRate": { "type": "number" }, "replyRateWithOOO": { "type": "number" }, "positiveReplyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "positiveReplyRate": { "type": "number" }, "bounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceRate": { "type": "number" }, "newLeadsContacted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalCompletedLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "totalLeads", "leadsContacted", "leadsContactedPercentage", "totalEmailsSent", "replyCount", "replyCountWithOOO", "replyRate", "replyRateWithOOO", "positiveReplyCount", "positiveReplyRate", "bounceCount", "bounceRate", "newLeadsContacted", "totalCompletedLeads" ], "patternProperties": { "^(?!(?:totalLeads|leadsContacted|leadsContactedPercentage|totalEmailsSent|replyCount|replyCountWithOOO|replyRate|replyRateWithOOO|positiveReplyCount|positiveReplyRate|bounceCount|bounceRate|newLeadsContacted|totalCompletedLeads|recipientBounceCount|senderBounceCount|unclassifiedBounceCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "totalLeads", "leadsContacted", "leadsContactedPercentage", "totalEmailsSent", "replyCount", "replyCountWithOOO", "replyRate", "replyRateWithOOO", "positiveReplyCount", "positiveReplyRate", "bounceCount", "bounceRate", "newLeadsContacted", "totalCompletedLeads", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount" ] } }, "dailyEmailSent": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "newLead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "followUp": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "newLead", "followUp" ], "patternProperties": { "^(?!(?:date|newLead|followUp)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "newLead", "followUp" ] } } }, "dailyMetrics": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "replyCountWithOOO": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "positiveReplyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "replyCountWithOOO", "replyCount", "positiveReplyCount", "bounceCount" ], "patternProperties": { "^(?!(?:date|replyCountWithOOO|replyCount|positiveReplyCount|bounceCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "replyCountWithOOO", "replyCount", "positiveReplyCount", "bounceCount" ] } } } }, "required": [ "summary", "dailyEmailSent", "dailyMetrics" ], "patternProperties": { "^(?!(?:summary|dailyEmailSent|dailyMetrics)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "dailyEmailSent", "dailyMetrics" ] } }, { "type": "object", "properties": { "summary": { "type": "object", "properties": { "receivedBySeeds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupEmailsSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sentByUs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "neverArrived": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "awaitingConfirmation": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "landedInInbox": { "type": "number" }, "landedInInboxCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "landedInSpam": { "type": "number" }, "landedInSpamCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "landedInTabs": { "type": "number" }, "landedInTabsCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "followUp": { "type": "object", "properties": { "windowMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "eligible": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "observed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tabs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unavailable": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pending": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "spamRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "tabsRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "windowMinutes", "eligible", "observed", "inbox", "spam", "tabs", "unavailable", "pending", "inboxRate", "spamRate", "tabsRate" ], "patternProperties": { "^(?!(?:windowMinutes|eligible|observed|inbox|spam|tabs|unavailable|pending|inboxRate|spamRate|tabsRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "windowMinutes", "eligible", "observed", "inbox", "spam", "tabs", "unavailable", "pending", "inboxRate", "spamRate", "tabsRate" ] } }, "bouncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "seedReplies": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "receivedBySeeds", "warmupEmailsSent", "sentByUs", "neverArrived", "awaitingConfirmation", "landedInInbox", "landedInInboxCount", "landedInSpam", "landedInSpamCount", "landedInTabs", "landedInTabsCount", "followUp", "bouncedCount", "seedReplies" ], "patternProperties": { "^(?!(?:receivedBySeeds|warmupEmailsSent|sentByUs|neverArrived|awaitingConfirmation|landedInInbox|landedInInboxCount|landedInSpam|landedInSpamCount|landedInTabs|landedInTabsCount|followUp|bouncedCount|seedReplies)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "receivedBySeeds", "warmupEmailsSent", "sentByUs", "neverArrived", "awaitingConfirmation", "landedInInbox", "landedInInboxCount", "landedInSpam", "landedInSpamCount", "landedInTabs", "landedInTabsCount", "followUp", "bouncedCount", "seedReplies" ] } }, "dailyDeliverability": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "received": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tabs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "followUpEligible": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "followUpUnavailable": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "sent", "received", "inbox", "spam", "tabs", "followUpEligible", "followUpUnavailable" ], "patternProperties": { "^(?!(?:date|sent|received|inbox|spam|tabs|followUpEligible|followUpUnavailable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "sent", "received", "inbox", "spam", "tabs", "followUpEligible", "followUpUnavailable" ] } } }, "placementByProvider": { "type": "array", "items": { "type": "object", "properties": { "provider": { "$ref": "#/$defs/ShortText" }, "received": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tabs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxRate": { "type": "number" }, "spamRate": { "type": "number" }, "tabsRate": { "type": "number" } }, "required": [ "provider", "received", "inbox", "spam", "tabs", "inboxRate", "spamRate", "tabsRate" ], "patternProperties": { "^(?!(?:provider|received|inbox|spam|tabs|inboxRate|spamRate|tabsRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "received", "inbox", "spam", "tabs", "inboxRate", "spamRate", "tabsRate" ] } } }, "sevenDayEngagement": { "type": "object", "properties": { "window": { "type": "object", "properties": { "from": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "to": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "hours": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "from", "to", "hours" ], "patternProperties": { "^(?!(?:from|to|hours)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "from", "to", "hours" ] } }, "pool": { "anyOf": [ { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "name": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } }, { "type": "null" } ] }, "desired": { "$ref": "#/$defs/Union_" }, "applied": { "type": "array", "items": { "type": "object", "properties": { "providerId": { "$ref": "#/$defs/ShortText" }, "status": { "$ref": "#/$defs/ShortText" }, "desiredPolicy": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "appliedPolicy": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "unsupportedControls": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "lastSyncAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastSyncError": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "providerId", "status", "desiredPolicy", "appliedPolicy", "unsupportedControls", "lastSyncAt", "lastSyncError" ], "patternProperties": { "^(?!(?:providerId|status|desiredPolicy|appliedPolicy|unsupportedControls|lastSyncAt|lastSyncError)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "providerId", "status", "desiredPolicy", "appliedPolicy", "unsupportedControls", "lastSyncAt", "lastSyncError" ] } } }, "observed": { "type": "object", "properties": { "composition": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "html": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rate": { "type": "number" } }, "required": [ "count", "rate" ], "patternProperties": { "^(?!(?:count|rate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "count", "rate" ] } }, "tracked": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "eligible": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rate": { "type": "number" } }, "required": [ "count", "eligible", "rate" ], "patternProperties": { "^(?!(?:count|eligible|rate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "count", "eligible", "rate" ] } }, "signed": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "eligible": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rate": { "type": "number" } }, "required": [ "count", "eligible", "rate" ], "patternProperties": { "^(?!(?:count|eligible|rate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "count", "eligible", "rate" ] } } }, "required": [ "total", "html", "tracked", "signed" ], "patternProperties": { "^(?!(?:total|html|tracked|signed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "html", "tracked", "signed" ] } }, "warmupip": { "type": "object", "properties": { "delivered": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "opens": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "clicks": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "openRate": { "type": "number" }, "clickRate": { "type": "number" } }, "required": [ "delivered", "opens", "clicks", "openRate", "clickRate" ], "patternProperties": { "^(?!(?:delivered|opens|clicks|openRate|clickRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "delivered", "opens", "clicks", "openRate", "clickRate" ] } }, "internalMesh": { "type": "object", "properties": { "delivered": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "read": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "clicked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replied": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "important": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rescuedFromSpam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "delivered", "read", "clicked", "replied", "important", "rescuedFromSpam" ], "patternProperties": { "^(?!(?:delivered|read|clicked|replied|important|rescuedFromSpam)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "delivered", "read", "clicked", "replied", "important", "rescuedFromSpam" ] } }, "localTracking": { "type": "object", "properties": { "opens": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "clicks": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rawOpens": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rawClicks": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "opens", "clicks", "rawOpens", "rawClicks" ], "patternProperties": { "^(?!(?:opens|clicks|rawOpens|rawClicks)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "opens", "clicks", "rawOpens", "rawClicks" ] } } }, "required": [ "composition", "warmupip", "internalMesh", "localTracking" ], "patternProperties": { "^(?!(?:composition|warmupip|internalMesh|localTracking)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "composition", "warmupip", "internalMesh", "localTracking" ] } } }, "required": [ "window", "pool", "desired", "applied", "observed" ], "patternProperties": { "^(?!(?:window|pool|desired|applied|observed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "window", "pool", "desired", "applied", "observed" ] } }, "deliveryIssues": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "bounced", "failed" ] }, "receiverEmail": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "reason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "occurredAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "status", "receiverEmail", "reason", "occurredAt" ], "patternProperties": { "^(?!(?:status|receiverEmail|reason|occurredAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "receiverEmail", "reason", "occurredAt" ] } } }, "deliveryIssuesPagination": { "type": "object", "properties": { "page": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPages": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "page", "pageSize", "total", "totalPages" ], "patternProperties": { "^(?!(?:page|pageSize|total|totalPages)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "page", "pageSize", "total", "totalPages" ] } } }, "required": [ "summary", "dailyDeliverability", "placementByProvider", "sevenDayEngagement", "deliveryIssues", "deliveryIssuesPagination" ], "patternProperties": { "^(?!(?:summary|dailyDeliverability|placementByProvider|sevenDayEngagement|deliveryIssues|deliveryIssuesPagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "dailyDeliverability", "placementByProvider", "sevenDayEngagement", "deliveryIssues", "deliveryIssuesPagination" ] } }, { "type": "object", "properties": { "windows": { "type": "object", "properties": { "evaluatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "bounceRecentStart": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "bouncePreviousStart": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "replyRecentEnd": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "replyRecentStart": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "replyPreviousStart": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "evaluatedAt", "bounceRecentStart", "bouncePreviousStart", "replyRecentEnd", "replyRecentStart", "replyPreviousStart" ], "patternProperties": { "^(?!(?:evaluatedAt|bounceRecentStart|bouncePreviousStart|replyRecentEnd|replyRecentStart|replyPreviousStart)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "evaluatedAt", "bounceRecentStart", "bouncePreviousStart", "replyRecentEnd", "replyRecentStart", "replyPreviousStart" ] } }, "policy": { "type": "object", "properties": { "windowDays": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyObservationHours": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "minBounceSends": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "minBounces": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceRatePercent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceIncreasePoints": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "minReplyContacts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "windowDays", "replyObservationHours", "minBounceSends", "minBounces", "bounceRatePercent", "bounceIncreasePoints", "minReplyContacts" ], "patternProperties": { "^(?!(?:windowDays|replyObservationHours|minBounceSends|minBounces|bounceRatePercent|bounceIncreasePoints|minReplyContacts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "windowDays", "replyObservationHours", "minBounceSends", "minBounces", "bounceRatePercent", "bounceIncreasePoints", "minReplyContacts" ] } }, "alerts": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/ShortText" }, "scope": { "type": "string", "enum": [ "inbox", "domain" ] }, "key": { "$ref": "#/$defs/ShortText" }, "label": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "code": { "type": "string", "enum": [ "high_bounce_rate", "bounce_rate_increase", "reply_rate_drop" ] }, "title": { "$ref": "#/$defs/ShortText" }, "description": { "$ref": "#/$defs/ShortText" }, "recommendation": { "$ref": "#/$defs/ShortText" }, "recent": { "type": "object", "properties": { "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contacts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replied": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "sent", "bounced", "contacts", "replied" ], "patternProperties": { "^(?!(?:sent|bounced|contacts|replied)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "sent", "bounced", "contacts", "replied" ] } }, "previous": { "type": "object", "properties": { "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contacts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replied": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "sent", "bounced", "contacts", "replied" ], "patternProperties": { "^(?!(?:sent|bounced|contacts|replied)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "sent", "bounced", "contacts", "replied" ] } } }, "required": [ "id", "scope", "key", "label", "code", "title", "description", "recommendation", "recent", "previous" ], "patternProperties": { "^(?!(?:id|scope|key|label|code|title|description|recommendation|recent|previous)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "scope", "key", "label", "code", "title", "description", "recommendation", "recent", "previous" ] } }, "maxItems": 100 }, "totalAlerts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "evaluatedScopes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "insufficientBounceSamples": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "insufficientReplySamples": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "windows", "policy", "alerts", "totalAlerts", "evaluatedScopes", "insufficientBounceSamples", "insufficientReplySamples" ], "patternProperties": { "^(?!(?:windows|policy|alerts|totalAlerts|evaluatedScopes|insufficientBounceSamples|insufficientReplySamples)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "windows", "policy", "alerts", "totalAlerts", "evaluatedScopes", "insufficientBounceSamples", "insufficientReplySamples" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "status": { "type": "string", "enum": [ "active", "inactive", "error", "alert" ] }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] } }, "required": [ "id", "emailAddress", "status", "provider" ], "patternProperties": { "^(?!(?:id|emailAddress|status|provider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "status", "provider" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "state": { "type": "string", "enum": [ "idle", "running", "completed", "failed" ] }, "runId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "step": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "progress": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "records": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "state", "runId", "step", "progress", "records", "error" ], "patternProperties": { "^(?!(?:state|runId|step|progress|records|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "state", "runId", "step", "progress", "records", "error" ] } }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderReplyTo": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "autoBcc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "autoCc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "dailySendingLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "minGapSeconds": { "anyOf": [ { "type": "integer", "minimum": 120, "maximum": 21600 }, { "type": "null" } ] }, "initialDailyLimit": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 100 }, { "type": "null" } ] }, "dailyIncrement": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50 }, { "type": "null" } ] }, "campaignEmailRampUp": { "type": "boolean" }, "signature": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "customVariables": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[a-z][a-z0-9_]*$" }, "value": { "type": "string", "minLength": 1, "maxLength": 10000 } }, "required": [ "key", "value" ], "patternProperties": { "^(?!(?:key|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "key", "value" ] } }, "maxItems": 50 }, "customTrackingDomain": { "anyOf": [ { "$ref": "#/$defs/DomainName" }, { "type": "null" } ] }, "customTrackingDomainVerified": { "type": "boolean" }, "syncNonCampaignEmails": { "type": "boolean" }, "isPlacementTestRecipient": { "type": "boolean" }, "canSyncNonCampaignEmails": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "color", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|color|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color", "description", "createdAt", "updatedAt" ] } } } }, "required": [ "id", "emailAddress", "senderFirstName", "senderLastName", "senderReplyTo", "autoBcc", "autoCc", "dailySendingLimit", "minGapSeconds", "initialDailyLimit", "dailyIncrement", "campaignEmailRampUp", "signature", "customVariables", "customTrackingDomain", "customTrackingDomainVerified", "syncNonCampaignEmails", "isPlacementTestRecipient", "canSyncNonCampaignEmails", "tags" ], "patternProperties": { "^(?!(?:id|emailAddress|senderFirstName|senderLastName|senderReplyTo|autoBcc|autoCc|dailySendingLimit|minGapSeconds|initialDailyLimit|dailyIncrement|campaignEmailRampUp|signature|customVariables|customTrackingDomain|customTrackingDomainVerified|syncNonCampaignEmails|isPlacementTestRecipient|canSyncNonCampaignEmails|tags)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "senderFirstName", "senderLastName", "senderReplyTo", "autoBcc", "autoCc", "dailySendingLimit", "minGapSeconds", "initialDailyLimit", "dailyIncrement", "campaignEmailRampUp", "signature", "customVariables", "customTrackingDomain", "customTrackingDomainVerified", "syncNonCampaignEmails", "isPlacementTestRecipient", "canSyncNonCampaignEmails", "tags" ] } }, { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "hetrixtools" ] }, "monitoredValues": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "run": { "type": "object", "properties": { "runId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "state": { "type": "string", "enum": [ "idle", "running", "completed", "failed" ] } }, "required": [ "runId", "state" ], "patternProperties": { "^(?!(?:runId|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "runId", "state" ] } }, "assets": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "kind": { "type": "string", "enum": [ "sending_domain", "tracking_domain" ] }, "value": { "$ref": "#/$defs/ShortText" }, "provider": { "$ref": "#/$defs/ShortText" }, "lastCheckStatus": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "lastCheckedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "checkedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "listedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warningCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "timeoutCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastError": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "listings": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "assetId": { "$ref": "#/$defs/OpaqueId" }, "listName": { "$ref": "#/$defs/ShortText" }, "info": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "detailUrl": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "firstListedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastSeenListedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "assetId", "listName", "info", "detailUrl", "firstListedAt", "lastSeenListedAt" ], "patternProperties": { "^(?!(?:id|assetId|listName|info|detailUrl|firstListedAt|lastSeenListedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "assetId", "listName", "info", "detailUrl", "firstListedAt", "lastSeenListedAt" ] } } } }, "required": [ "id", "kind", "value", "provider", "lastCheckStatus", "lastCheckedAt", "checkedCount", "listedCount", "warningCount", "timeoutCount", "lastError", "listings" ], "patternProperties": { "^(?!(?:id|kind|value|provider|lastCheckStatus|lastCheckedAt|checkedCount|listedCount|warningCount|timeoutCount|lastError|listings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "value", "provider", "lastCheckStatus", "lastCheckedAt", "checkedCount", "listedCount", "warningCount", "timeoutCount", "lastError", "listings" ] } } } }, "required": [ "provider", "monitoredValues", "run", "assets" ], "patternProperties": { "^(?!(?:provider|monitoredValues|run|assets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "monitoredValues", "run", "assets" ] } }, { "type": "object", "properties": { "recipients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] } }, "required": [ "id", "emailAddress", "provider" ], "patternProperties": { "^(?!(?:id|emailAddress|provider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "provider" ] } } }, "tests": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "recipientInboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "subject": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "pending", "sending", "observing", "completed", "failed", "send_uncertain" ] }, "sentAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "errorMessage": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "observations": { "type": "array", "items": { "type": "object", "properties": { "checkpointSeconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "placement": { "type": "string", "enum": [ "inbox", "tabs", "spam", "other", "not_found", "error" ] }, "isRead": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "errorMessage": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "observedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "checkpointSeconds", "placement", "isRead", "errorMessage", "observedAt" ], "patternProperties": { "^(?!(?:checkpointSeconds|placement|isRead|errorMessage|observedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "checkpointSeconds", "placement", "isRead", "errorMessage", "observedAt" ] } } } }, "required": [ "id", "recipientInboxId", "subject", "status", "sentAt", "createdAt", "errorMessage", "observations" ], "patternProperties": { "^(?!(?:id|recipientInboxId|subject|status|sentAt|createdAt|errorMessage|observations)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "recipientInboxId", "subject", "status", "sentAt", "createdAt", "errorMessage", "observations" ] } } } }, "required": [ "recipients", "tests" ], "patternProperties": { "^(?!(?:recipients|tests)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "recipients", "tests" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "status": { "type": "string", "enum": [ "active", "inactive", "error", "alert" ] }, "statusDetail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "dailySendingLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "minGapSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupEnabled": { "type": "boolean" }, "dailyWarmupLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "tags": { "$ref": "#/$defs/ShortText" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "emailAddress", "provider", "status", "statusDetail", "dailySendingLimit", "minGapSeconds", "warmupEnabled", "dailyWarmupLimit", "tags", "createdAt" ], "patternProperties": { "^(?!(?:emailAddress|provider|status|statusDetail|dailySendingLimit|minGapSeconds|warmupEnabled|dailyWarmupLimit|tags|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "emailAddress", "provider", "status", "statusDetail", "dailySendingLimit", "minGapSeconds", "warmupEnabled", "dailyWarmupLimit", "tags", "createdAt" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `inboxes.list`: `GET /v1/workspaces/:workspaceId/inboxes` - `inboxes.stats`: `GET /v1/workspaces/:workspaceId/inboxes/stats` - `inboxes.rowStats`: `GET /v1/workspaces/:workspaceId/inboxes/:inboxId/row-stats` - `inboxes.batchRowStats`: `POST /v1/workspaces/:workspaceId/inboxes/row-stats/batch` - `inboxes.accountAnalytics`: `GET /v1/workspaces/:workspaceId/inboxes/:inboxId/account-analytics` - `inboxes.warmupAnalytics`: `GET /v1/workspaces/:workspaceId/inboxes/:inboxId/warmup-analytics` - `inboxes.recentHealth`: `GET /v1/workspaces/:workspaceId/inboxes/recent-health` - `inboxes.subscriptionTargets`: `GET /v1/workspaces/:workspaceId/inboxes/subscription-targets` - `inboxes.dnsCheckStatus`: `GET /v1/workspaces/:workspaceId/inboxes/:inboxId/dns-check-status` - `inboxSettings.get`: `GET /v1/workspaces/:workspaceId/inboxes/:inboxId/settings` - `inboxDeliverability.get`: `GET /v1/workspaces/:workspaceId/inboxes/:inboxId/deliverability` - `inboxPlacementDiagnostics.get`: `GET /v1/workspaces/:workspaceId/inboxes/:inboxId/placement-diagnostics` - `inboxBulk.export`: `POST /v1/workspaces/:workspaceId/inboxes/bulk/export`