Stats

Return server stats

get/v1/stats

Request

  • Base URL: https://your-emailengine-host
  • URL: https://your-emailengine-host/v1/stats
  • Auth: HTTP bearer

Query parameters

secondsinteger

Duration for counters

Example:3600

Headers

x-ee-timeoutinteger

Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect

Example:30000

Response

Returns counters, connection states and process information for this instance.

versionstring

EmailEngine version number

licensestring

EmailEngine license

accountsinteger

Number of registered accounts

nodestring

Node.js Version

redisstring

Redis version. Can include the server software in parentheses, or an error message if the version lookup failed

redisSoftwarestring

Redis-compatible server software name

redisClusterboolean

Whether Redis is running in cluster mode

redisPingnumber

Redis latency in milliseconds

imapflowstring

ImapFlow version

bullmqstring

BullMQ version

archstring

CPU architecture of the host

buildBuildInfo

Build information for the running EmailEngine instance

queuesQueueStats

Job counters for the notify and submit queues

countersCounterStats

Example response

{
  "version": "2.83.2",
  "license": "LICENSE_EMAILENGINE",
  "accounts": 26,
  "node": "16.10.0",
  "redis": "6.2.4",
  "redisSoftware": "redis",
  "redisWarnings": [
    {
      "key": "maxmemory-policy",
      "color": "warning",
      "title": "Unsafe Redis eviction policy",
      "details": [
        "maxmemory-policy is allkeys-lru"
      ]
    }
  ],
  "redisPing": 1.2,
  "imapflow": "1.0.188",
  "bullmq": "5.0.0",
  "arch": "arm64",
  "connections": {
    "init": 2,
    "connected": 8,
    "connecting": 7,
    "syncing": 1,
    "authenticationError": 3,
    "connectError": 5,
    "disconnected": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.