Mailneo
|Docs

Analytics

Analytics API

3 endpoints under https://api.mailneo.co/api/v2. Every request carries your key in the x-api-key header.

Scope used on this page: analytics:read. Each endpoint below states the one it requires. Start with the quickstart →

GET/analytics/overview

Delivery and engagement totals

Requires analytics:read

Event counts by type over a period, optionally narrowed to one campaign. Defaults to the last 30 days; the window may not exceed 366 days.

These are EVENT counts, not unique recipients — one person opening a message five times contributes five to opened. No rates are published for that reason; compute them yourself if you know how you want them denominated.

Query parameters3
startstring · date-time
endstring · date-time
campaign_idstring≤ 64 chars
curl "https://api.mailneo.co/api/v2/analytics/overview" \
  -H "x-api-key: $MAILNEO_API_KEY"
{
  "data": {
    "object": "analytics_overview",
    "period_start": "2026-05-11T09:30:00.000Z",
    "period_end": "2026-06-24T15:45:00.000Z",
    "events": {
      "delivered": 1,
      "opened": 1,
      "clicked": 1,
      "bounced": 1,
      "soft_bounced": 1,
      "complained": 1,
      "unsubscribed": 1,
      "deferred": 1,
      "dropped": 1,
      "spam_reported": 1
    }
  },
  "meta": {
    "request_id": "631b7aec-641b-4c7f-a51b-7e12661b7fa5"
  }
}
GET/analytics/devices

Device, OS and browser breakdown

Requires analytics:read

Where recipients engaged from, by volume. Counts OPEN and CLICK events only — every other event type is generated server-side and carries no user agent, so including them would add a large unknown bucket that means "not applicable" rather than "could not be parsed".

Values that could not be parsed are reported as unknown rather than dropped, so the buckets sum to the engagement-event total.

Query parameters3
startstring · date-time
endstring · date-time
campaign_idstring≤ 64 chars
curl "https://api.mailneo.co/api/v2/analytics/devices" \
  -H "x-api-key: $MAILNEO_API_KEY"
{
  "data": {
    "object": "analytics_devices",
    "period_start": "2026-05-11T09:30:00.000Z",
    "period_end": "2026-06-24T15:45:00.000Z",
    "devices": [
      {
        "device_type": "desktop",
        "events": 1
      }
    ],
    "operating_systems": [
      {
        "os": "macOS",
        "events": 1
      }
    ],
    "browsers": [
      {
        "browser": "Chrome",
        "events": 1
      }
    ]
  },
  "meta": {
    "request_id": "6eed838c-6fed-451f-a0ed-86b271ed8845"
  }
}
GET/analytics/geography

Country breakdown

Requires analytics:read

Where recipients engaged from, by country, ordered by volume. Counts OPEN and CLICK events only, for the same reason as the device breakdown.

Country is derived from the IP address seen at engagement time. Treat it as indicative: opens routed through a proxy or an image-caching relay resolve to the relay, not the recipient.

Query parameters3
startstring · date-time
endstring · date-time
campaign_idstring≤ 64 chars
curl "https://api.mailneo.co/api/v2/analytics/geography" \
  -H "x-api-key: $MAILNEO_API_KEY"
{
  "data": {
    "object": "analytics_geography",
    "period_start": "2026-05-11T09:30:00.000Z",
    "period_end": "2026-06-24T15:45:00.000Z",
    "countries": [
      {
        "country": "US",
        "events": 1
      }
    ]
  },
  "meta": {
    "request_id": "a3e6b25d-a2e6-40ca-a1e6-af37a0e6ada4"
  }
}