---
title: "Return all cPanel accounts email tracking statistics"
method: GET
path: "/emailtrack_user_stats"
tags: ["Mail", "cPanel Account Mail Management"]
---

# Return all cPanel accounts email tracking statistics

`GET /emailtrack_user_stats`

This function retrieves email tracking statistics for each user.

## Query parameters

- `deliverytype` 'remote' | 'remote-or-faildefer' | 'local'
- `endtime` integer
- `sender` string, email
- `starttime` integer

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `records` object[] — An array of objects containing the message information.
      - `DEFERCOUNT` integer — The number of deferral events.
      - `DEFERFAILCOUNT` integer — The number of messages that the system deferred and failed to deliver.
      - `DOMAIN` string, domain — The mailbox's domain.
      - `FAILCOUNT` integer — The number of delivery failures. **Note:** If you assign a message three recipients, the system can fail to deliver the message three times.
      - `OWNER` string — The mailbox's account owner.
      - `PRIMARY_DOMAIN` string, domain — The mailbox account's primary domain.
      - `REACHED_MAXDEFERFAIL` 0 | 1 — Whether the mailbox reached the maximum number of failed deferred messages. * `1` — Reached. * `0` — Has **not** reached.
      - `REACHED_MAXEMAILS` 0 | 1 — Whether the mailbox has reached the maximum number of messages allowed per hour. * `1` — Reached. * `0` — Has **not** reached.
      - `SENDCOUNT` integer — The number of sent messages.
      - `SUCCESSCOUNT` integer — The number of successful deliveries. **Note:** If you assign a message three recipients, the system can successfully deliver the message three times.
      - `TOTALSIZE` integer — The total size of messages sent by the server.
      - `USER` string — The mailbox's owner.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` — Success * `0` — Failed: Check the reason field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)
