{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/groundmail-dev/json-schema/groundmail-dev-deliverability-insights-response-schema.json",
  "title": "DeliverabilityInsightsResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/groundmail-dev-deliverability-api-openapi.yml#/components/schemas/DeliverabilityInsightsResponse",
  "type": "object",
  "required": [
    "window",
    "window_start",
    "generated_at",
    "summary",
    "by_domain",
    "top_bounce_reasons",
    "notes"
  ],
  "properties": {
    "window": {
      "type": "string",
      "enum": [
        "7d",
        "30d"
      ]
    },
    "window_start": {
      "type": "string",
      "format": "date-time"
    },
    "generated_at": {
      "type": "string",
      "format": "date-time"
    },
    "summary": {
      "$ref": "#/$defs/DeliverabilityBucket"
    },
    "by_domain": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/DeliverabilityDomainInsight"
      }
    },
    "top_bounce_reasons": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "reason",
          "count"
        ],
        "properties": {
          "reason": {
            "type": "string"
          },
          "count": {
            "type": "integer"
          }
        }
      }
    },
    "notes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "by_stream_24h": {
      "type": "array",
      "description": "Sent, bounced and complained per mail stream over the last 24 hours (live\ncounts), for streams with activity. Each stream sends from its own IPs.\n",
      "items": {
        "type": "object",
        "required": [
          "stream",
          "sent",
          "bounced",
          "complained",
          "bounce_rate",
          "complaint_rate"
        ],
        "properties": {
          "stream": {
            "$ref": "#/$defs/MailStream"
          },
          "sent": {
            "type": "integer"
          },
          "bounced": {
            "type": "integer"
          },
          "complained": {
            "type": "integer"
          },
          "bounce_rate": {
            "type": "number"
          },
          "complaint_rate": {
            "type": "number"
          }
        }
      }
    }
  },
  "$defs": {
    "DeliverabilityBucket": {
      "type": "object",
      "required": [
        "total_emails",
        "attempted",
        "sent",
        "delivered",
        "bounced",
        "complained",
        "failed",
        "suppressed",
        "scheduled",
        "opened",
        "clicked",
        "bounce_rate",
        "complaint_rate",
        "delivery_rate",
        "open_rate",
        "click_rate"
      ],
      "properties": {
        "total_emails": {
          "type": "integer"
        },
        "attempted": {
          "type": "integer"
        },
        "sent": {
          "type": "integer"
        },
        "delivered": {
          "type": "integer"
        },
        "bounced": {
          "type": "integer"
        },
        "complained": {
          "type": "integer"
        },
        "failed": {
          "type": "integer"
        },
        "suppressed": {
          "type": "integer"
        },
        "scheduled": {
          "type": "integer"
        },
        "opened": {
          "type": "integer"
        },
        "clicked": {
          "type": "integer"
        },
        "bounce_rate": {
          "type": "number"
        },
        "complaint_rate": {
          "type": "number"
        },
        "delivery_rate": {
          "type": "number"
        },
        "open_rate": {
          "type": "number"
        },
        "click_rate": {
          "type": "number"
        }
      }
    },
    "DeliverabilityDomainInsight": {
      "allOf": [
        {
          "$ref": "#/$defs/DeliverabilityBucket"
        },
        {
          "type": "object",
          "required": [
            "domain"
          ],
          "properties": {
            "domain": {
              "type": "string"
            },
            "mail_server_relay": {
              "$ref": "#/$defs/DeliverabilityMailServerRelay"
            }
          }
        }
      ]
    },
    "DeliverabilityMailServerRelay": {
      "type": "object",
      "required": [
        "window_days",
        "total_messages",
        "sent",
        "bounced",
        "failed",
        "delayed"
      ],
      "properties": {
        "window_days": {
          "type": "integer",
          "description": "Lookback window in days for relay-side counts."
        },
        "total_messages": {
          "type": "integer"
        },
        "sent": {
          "type": "integer"
        },
        "bounced": {
          "type": "integer"
        },
        "failed": {
          "type": "integer"
        },
        "delayed": {
          "type": "integer"
        }
      },
      "description": "Optional relay-side delivery counts from the transactional mail server when relay metrics are available."
    },
    "MailStream": {
      "type": "string",
      "enum": [
        "transactional",
        "product",
        "newsletter"
      ],
      "description": "The mail stream an email went out on, from its `category`. Each stream sends\nfrom its own IPs. `newsletter` is for approved accounts only.\n"
    }
  }
}