read_warmup_stats
Read warmup placement statistics for one inbox or the whole workspace — rates, daily series, and breakdowns, never peer identities.
# 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_warmup_stats
Read warmup placement statistics for one inbox or the whole workspace — rates, daily series, and breakdowns, never peer identities.
Use to report warmup progress, inbox placement, or follow-up funnel health for the workspace.
Stats are aggregates only; they never expose warmup peer addresses, and they do not manage providers or inboxes.
Scopes: inbox:read
Risk: read; confirmation: none; idempotency: none.
### Input schema (personal API key)
```json
{
"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"
},
"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"
},
"groupBy": {
"type": "string",
"enum": [
"esp",
"recipient_esp",
"tag",
"domain"
]
}
},
"required": [
"workspaceId"
],
"patternProperties": {
"^(?!(?:workspaceId|inboxId|startDate|endDate|groupBy)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"inboxId",
"startDate",
"endDate",
"groupBy"
]
},
"$defs": {
"LocalDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
}
}
```
### Input schema (OAuth / delegated agent)
```json
{
"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"
},
"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"
},
"groupBy": {
"type": "string",
"enum": [
"esp",
"recipient_esp",
"tag",
"domain"
]
}
},
"required": [
"workspaceId"
],
"patternProperties": {
"^(?!(?:workspaceId|inboxId|startDate|endDate|groupBy)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"inboxId",
"startDate",
"endDate",
"groupBy"
]
},
"$defs": {
"LocalDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
}
}
```
### Output schema (structuredContent)
```json
{
"$defs": {
"LocalDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"ShortText": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"type": "object",
"anyOf": [
{
"allOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"summary": {
"type": "object",
"properties": {
"reputationScore": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"totalEmailsSent": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"totalEmailsReceived": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"deliverabilityRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"currentDailyVolume": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"targetDailyVolume": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"warmupProgress": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
}
},
"required": [
"reputationScore",
"totalEmailsSent",
"totalEmailsReceived",
"deliverabilityRate",
"currentDailyVolume",
"targetDailyVolume",
"warmupProgress"
],
"patternProperties": {
"^(?!(?:reputationScore|totalEmailsSent|totalEmailsReceived|deliverabilityRate|currentDailyVolume|targetDailyVolume|warmupProgress)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"reputationScore",
"totalEmailsSent",
"totalEmailsReceived",
"deliverabilityRate",
"currentDailyVolume",
"targetDailyVolume",
"warmupProgress"
]
}
},
"dailyStats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"$ref": "#/$defs/LocalDate"
},
"sent": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"received": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"inboxDelivery": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"spamDelivery": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"tabsDelivery": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"opens": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"date",
"sent",
"received",
"inboxDelivery",
"spamDelivery",
"tabsDelivery",
"opens"
],
"patternProperties": {
"^(?!(?:date|sent|received|inboxDelivery|spamDelivery|tabsDelivery|opens)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"date",
"sent",
"received",
"inboxDelivery",
"spamDelivery",
"tabsDelivery",
"opens"
]
}
}
},
"sendsByProvider": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"$ref": "#/$defs/ShortText"
},
"sent": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"provider",
"sent"
],
"patternProperties": {
"^(?!(?:provider|sent)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"provider",
"sent"
]
}
}
}
},
"required": [
"summary",
"dailyStats",
"sendsByProvider"
],
"patternProperties": {
"^(?!(?:summary|dailyStats|sendsByProvider)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"summary",
"dailyStats",
"sendsByProvider"
]
}
},
{
"type": "object",
"properties": {
"inboxesWarming": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"summary": {
"type": "object",
"properties": {
"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
},
"sentByUs": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"neverArrived": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"awaitingConfirmation": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"inboxRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"spamRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"tabsRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"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
},
"unavailable": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"pending": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"daily": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"$ref": "#/$defs/LocalDate"
},
"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
}
},
"required": [
"date",
"received",
"inbox",
"spam",
"tabs"
],
"patternProperties": {
"^(?!(?:date|received|inbox|spam|tabs)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"date",
"received",
"inbox",
"spam",
"tabs"
]
}
}
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"$ref": "#/$defs/ShortText"
},
"label": {
"$ref": "#/$defs/ShortText"
},
"inboxCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"received": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sent": {
"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": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"spamRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"tabsRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
}
},
"required": [
"key",
"label",
"inboxCount",
"received",
"sent",
"inbox",
"spam",
"tabs",
"inboxRate",
"spamRate",
"tabsRate"
],
"patternProperties": {
"^(?!(?:key|label|inboxCount|received|sent|inbox|spam|tabs|inboxRate|spamRate|tabsRate)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"key",
"label",
"inboxCount",
"received",
"sent",
"inbox",
"spam",
"tabs",
"inboxRate",
"spamRate",
"tabsRate"
]
}
}
}
},
"required": [
"windowMinutes",
"eligible",
"observed",
"unavailable",
"pending",
"daily",
"groups"
],
"patternProperties": {
"^(?!(?:windowMinutes|eligible|observed|unavailable|pending|daily|groups)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"windowMinutes",
"eligible",
"observed",
"unavailable",
"pending",
"daily",
"groups"
]
}
}
},
"required": [
"sent",
"received",
"inbox",
"spam",
"tabs",
"sentByUs",
"neverArrived",
"awaitingConfirmation",
"inboxRate",
"spamRate",
"tabsRate",
"followUp"
],
"patternProperties": {
"^(?!(?:sent|received|inbox|spam|tabs|sentByUs|neverArrived|awaitingConfirmation|inboxRate|spamRate|tabsRate|followUp)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"sent",
"received",
"inbox",
"spam",
"tabs",
"sentByUs",
"neverArrived",
"awaitingConfirmation",
"inboxRate",
"spamRate",
"tabsRate",
"followUp"
]
}
},
"daily": {
"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
}
},
"required": [
"date",
"sent",
"received",
"inbox",
"spam",
"tabs"
],
"patternProperties": {
"^(?!(?:date|sent|received|inbox|spam|tabs)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"date",
"sent",
"received",
"inbox",
"spam",
"tabs"
]
}
}
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"$ref": "#/$defs/ShortText"
},
"label": {
"$ref": "#/$defs/ShortText"
},
"inboxCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"received": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sent": {
"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": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"spamRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"tabsRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
}
},
"required": [
"key",
"label",
"inboxCount",
"received",
"sent",
"inbox",
"spam",
"tabs",
"inboxRate",
"spamRate",
"tabsRate"
],
"patternProperties": {
"^(?!(?:key|label|inboxCount|received|sent|inbox|spam|tabs|inboxRate|spamRate|tabsRate)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"key",
"label",
"inboxCount",
"received",
"sent",
"inbox",
"spam",
"tabs",
"inboxRate",
"spamRate",
"tabsRate"
]
}
}
}
},
"required": [
"inboxesWarming",
"summary",
"daily",
"groups"
],
"patternProperties": {
"^(?!(?:inboxesWarming|summary|daily|groups)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"inboxesWarming",
"summary",
"daily",
"groups"
]
}
}
]
},
{
"type": "object"
}
]
},
{
"type": "object",
"properties": {
"data": {
"allOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"summary": {
"type": "object",
"properties": {
"reputationScore": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"totalEmailsSent": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"totalEmailsReceived": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"deliverabilityRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"currentDailyVolume": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"targetDailyVolume": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"warmupProgress": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
}
},
"required": [
"reputationScore",
"totalEmailsSent",
"totalEmailsReceived",
"deliverabilityRate",
"currentDailyVolume",
"targetDailyVolume",
"warmupProgress"
],
"patternProperties": {
"^(?!(?:reputationScore|totalEmailsSent|totalEmailsReceived|deliverabilityRate|currentDailyVolume|targetDailyVolume|warmupProgress)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"reputationScore",
"totalEmailsSent",
"totalEmailsReceived",
"deliverabilityRate",
"currentDailyVolume",
"targetDailyVolume",
"warmupProgress"
]
}
},
"dailyStats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"$ref": "#/$defs/LocalDate"
},
"sent": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"received": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"inboxDelivery": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"spamDelivery": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"tabsDelivery": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"opens": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"date",
"sent",
"received",
"inboxDelivery",
"spamDelivery",
"tabsDelivery",
"opens"
],
"patternProperties": {
"^(?!(?:date|sent|received|inboxDelivery|spamDelivery|tabsDelivery|opens)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"date",
"sent",
"received",
"inboxDelivery",
"spamDelivery",
"tabsDelivery",
"opens"
]
}
}
},
"sendsByProvider": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"$ref": "#/$defs/ShortText"
},
"sent": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"provider",
"sent"
],
"patternProperties": {
"^(?!(?:provider|sent)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"provider",
"sent"
]
}
}
}
},
"required": [
"summary",
"dailyStats",
"sendsByProvider"
],
"patternProperties": {
"^(?!(?:summary|dailyStats|sendsByProvider)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"summary",
"dailyStats",
"sendsByProvider"
]
}
},
{
"type": "object",
"properties": {
"inboxesWarming": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"summary": {
"type": "object",
"properties": {
"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
},
"sentByUs": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"neverArrived": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"awaitingConfirmation": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"inboxRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"spamRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"tabsRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"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
},
"unavailable": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"pending": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"daily": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"$ref": "#/$defs/LocalDate"
},
"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
}
},
"required": [
"date",
"received",
"inbox",
"spam",
"tabs"
],
"patternProperties": {
"^(?!(?:date|received|inbox|spam|tabs)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"date",
"received",
"inbox",
"spam",
"tabs"
]
}
}
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"$ref": "#/$defs/ShortText"
},
"label": {
"$ref": "#/$defs/ShortText"
},
"inboxCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"received": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sent": {
"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": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"spamRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"tabsRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
}
},
"required": [
"key",
"label",
"inboxCount",
"received",
"sent",
"inbox",
"spam",
"tabs",
"inboxRate",
"spamRate",
"tabsRate"
],
"patternProperties": {
"^(?!(?:key|label|inboxCount|received|sent|inbox|spam|tabs|inboxRate|spamRate|tabsRate)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"key",
"label",
"inboxCount",
"received",
"sent",
"inbox",
"spam",
"tabs",
"inboxRate",
"spamRate",
"tabsRate"
]
}
}
}
},
"required": [
"windowMinutes",
"eligible",
"observed",
"unavailable",
"pending",
"daily",
"groups"
],
"patternProperties": {
"^(?!(?:windowMinutes|eligible|observed|unavailable|pending|daily|groups)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"windowMinutes",
"eligible",
"observed",
"unavailable",
"pending",
"daily",
"groups"
]
}
}
},
"required": [
"sent",
"received",
"inbox",
"spam",
"tabs",
"sentByUs",
"neverArrived",
"awaitingConfirmation",
"inboxRate",
"spamRate",
"tabsRate",
"followUp"
],
"patternProperties": {
"^(?!(?:sent|received|inbox|spam|tabs|sentByUs|neverArrived|awaitingConfirmation|inboxRate|spamRate|tabsRate|followUp)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"sent",
"received",
"inbox",
"spam",
"tabs",
"sentByUs",
"neverArrived",
"awaitingConfirmation",
"inboxRate",
"spamRate",
"tabsRate",
"followUp"
]
}
},
"daily": {
"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
}
},
"required": [
"date",
"sent",
"received",
"inbox",
"spam",
"tabs"
],
"patternProperties": {
"^(?!(?:date|sent|received|inbox|spam|tabs)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"date",
"sent",
"received",
"inbox",
"spam",
"tabs"
]
}
}
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"$ref": "#/$defs/ShortText"
},
"label": {
"$ref": "#/$defs/ShortText"
},
"inboxCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"received": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sent": {
"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": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"spamRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"tabsRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
}
},
"required": [
"key",
"label",
"inboxCount",
"received",
"sent",
"inbox",
"spam",
"tabs",
"inboxRate",
"spamRate",
"tabsRate"
],
"patternProperties": {
"^(?!(?:key|label|inboxCount|received|sent|inbox|spam|tabs|inboxRate|spamRate|tabsRate)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"key",
"label",
"inboxCount",
"received",
"sent",
"inbox",
"spam",
"tabs",
"inboxRate",
"spamRate",
"tabsRate"
]
}
}
}
},
"required": [
"inboxesWarming",
"summary",
"daily",
"groups"
],
"patternProperties": {
"^(?!(?:inboxesWarming|summary|daily|groups)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"inboxesWarming",
"summary",
"daily",
"groups"
]
}
}
]
},
{
"not": {
"type": "object"
}
}
]
}
},
"required": [
"data"
],
"additionalProperties": false
}
]
}
```
### Underlying API operations
- `warmupStats.inbox`: `GET /v1/workspaces/:workspaceId/warmup/stats/inboxes/:inboxId`
- `warmupStats.organization`: `GET /v1/workspaces/:workspaceId/warmup/stats/organization`
Scheduler Zero