Skip to main content

Overview

The analytics endpoints give you visibility into your email delivery performance. All analytics endpoints require the stats:read scope.

Aggregate stats

Get overall delivery metrics for a date range:
curl "https://api.mail.gorillaa.one/v1/stats?start_date=2026-02-01T00:00:00Z&end_date=2026-02-09T00:00:00Z" \
  -H "Authorization: Bearer YOUR_API_KEY"

Query parameters

ParameterTypeRequiredDescription
start_datestringISO 8601 start date
end_datestringISO 8601 end date
domain_idstringFilter by domain ID (UUID)

Response

{
  "data": {
    "period": {
      "from": "2026-02-01T00:00:00Z",
      "to": "2026-02-09T00:00:00Z"
    },
    "stats": {
      "total": 15420,
      "queued": 0,
      "sending": 0,
      "sent": 15210,
      "delivered": 15105,
      "bounced": 210,
      "failed": 5,
      "opens": 8750,
      "clicks": 2340,
      "deliveryRate": 0.9796,
      "openRate": 0.5792,
      "clickRate": 0.1549,
      "bounceRate": 0.0136
    }
  }
}

Per-domain breakdown

Get the same metrics broken down by sending domain:
curl "https://api.mail.gorillaa.one/v1/stats/domains?start_date=2026-02-01T00:00:00Z&end_date=2026-02-09T00:00:00Z" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "data": {
    "period": {
      "from": "2026-02-01T00:00:00Z",
      "to": "2026-02-09T00:00:00Z"
    },
    "domains": [
      {
        "domain": "yourdomain.com",
        "total": 12000,
        "sent": 11950,
        "delivered": 11800,
        "bounced": 150,
        "opens": 7200,
        "clicks": 1900,
        "deliveryRate": 0.9833,
        "bounceRate": 0.0125
      },
      {
        "domain": "notifications.yourdomain.com",
        "total": 3420,
        "sent": 3400,
        "delivered": 3305,
        "bounced": 60,
        "opens": 1550,
        "clicks": 440,
        "deliveryRate": 0.9664,
        "bounceRate": 0.0175
      }
    ]
  }
}

Hourly time-series

Get hourly delivery metrics for trend analysis. Maximum date range is 7 days.
curl "https://api.mail.gorillaa.one/v1/stats/hourly?start_date=2026-02-08T00:00:00Z&end_date=2026-02-09T00:00:00Z" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "data": {
    "period": {
      "from": "2026-02-08T00:00:00Z",
      "to": "2026-02-09T00:00:00Z"
    },
    "hourly": [
      {
        "timestamp": "2026-02-08T00:00:00Z",
        "sent": 120,
        "delivered": 118,
        "bounced": 2,
        "opens": 45,
        "clicks": 12
      },
      {
        "timestamp": "2026-02-08T01:00:00Z",
        "sent": 95,
        "delivered": 94,
        "bounced": 1,
        "opens": 38,
        "clicks": 8
      }
    ]
  }
}

Sender reputation

Get your organization’s sender reputation score and health status:
curl "https://api.mail.gorillaa.one/v1/stats/reputation" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "data": {
    "organizationId": "org_abc123",
    "metrics": {
      "overallScore": 92,
      "bounceRate": 0.012,
      "complaintRate": 0.0002,
      "deliveryRate": 0.985,
      "healthStatus": "excellent"
    },
    "recommendations": [
      "Your delivery metrics are excellent. Keep up the good work!"
    ]
  }
}

Health status levels

ScoreStatusMeaning
90–100excellentTop-tier reputation. No action needed.
75–89goodHealthy. Monitor for any downward trends.
50–74fairSome issues detected. Review bounce/complaint rates.
25–49poorReputation at risk. Action required.
0–24criticalSending may be throttled. Immediate action required.
A critical reputation can result in mail providers silently dropping or spam-filtering your emails. Address bounces and complaints immediately.