Add Stats API

CHANGELOG.md

@@ -1,3 +1,6 @@
+## [4.5.0] - 2025-03-06
+- Add StatsApi with get, byDomains, byCategories, byEmailServiceProviders, byDate endpoints
+
 ## [4.4.0] - 2025-12-08
 - Add ES module support by specifying import path in package.json by @narekhovhannisyan in https://github.com/mailtrap/mailtrap-nodejs/pull/112
 - Bump new minor version as previous changes were pretty huge and shouldn't be released under patch version

examples/general/stats.ts

@@ -0,0 +1,98 @@
+import { MailtrapClient } from "mailtrap"
+
+const TOKEN = "<YOUR-TOKEN-HERE>";
+const TEST_INBOX_ID = "<YOUR-TEST-INBOX-ID-HERE>"
+const ACCOUNT_ID = 123456
+
+const client = new MailtrapClient({ token: TOKEN, testInboxId: TEST_INBOX_ID, accountId: ACCOUNT_ID });
+
+const statsClient = client.general.stats
+
+const testGetStats = async () => {
+  try {
+    const result = await statsClient.get({
+      start_date: "2026-01-01",
+      end_date: "2026-01-31",
+    })
+    console.log("Stats:", JSON.stringify(result, null, 2))
+  } catch (error) {
+    console.error(error)
+  }
+}
+
+const testGetStatsWithFilters = async () => {
+  try {
+    const result = await statsClient.get({
+      start_date: "2026-01-01",
+      end_date: "2026-01-31",
+      sending_domain_ids: [1, 2],
+      sending_streams: ["transactional"],
+      categories: ["Transactional", "Marketing"],
+      email_service_providers: ["Gmail", "Yahoo"],
+    })
+    console.log("Filtered stats:", JSON.stringify(result, null, 2))
+  } catch (error) {
+    console.error(error)
+  }
+}
+
+const testGetStatsByDomains = async () => {
+  try {
+    const result = await statsClient.byDomains({
+      start_date: "2026-01-01",
+      end_date: "2026-01-31",
+    })
+    console.log("Stats by domains:", JSON.stringify(result, null, 2))
+  } catch (error) {
+    console.error(error)
+  }
+}
+
+const testGetStatsByCategories = async () => {
+  try {
+    const result = await statsClient.byCategories({
+      start_date: "2026-01-01",
+      end_date: "2026-01-31",
+    })
+    console.log("Stats by categories:", JSON.stringify(result, null, 2))
+  } catch (error) {
+    console.error(error)
+  }
+}
+
+const testGetStatsByEmailServiceProviders = async () => {
+  try {
+    const result = await statsClient.byEmailServiceProviders({
+      start_date: "2026-01-01",
+      end_date: "2026-01-31",
+    })
+    console.log("Stats by email service providers:", JSON.stringify(result, null, 2))
+  } catch (error) {
+    console.error(error)
+  }
+}
+
+const testGetStatsByDate = async () => {
+  try {
+    const result = await statsClient.byDate({
+      start_date: "2026-01-01",
+      end_date: "2026-01-31",
+    })
+    console.log("Stats by date:", JSON.stringify(result, null, 2))
+  } catch (error) {
+    console.error(error)
+  }
+}
+
+(async () => {
+  try {
+    await testGetStats()
+    await testGetStatsWithFilters()
+    await testGetStatsByDomains()
+    await testGetStatsByCategories()
+    await testGetStatsByEmailServiceProviders()
+    await testGetStatsByDate()
+  } catch (error) {
+    console.error("Error running stats examples:", error)
+  }
+})()

package.json

@@ -1,7 +1,7 @@
 {
   "name": "mailtrap",
   "description": "Official mailtrap.io API client",
-  "version": "4.4.0",
+  "version": "4.5.0",
   "author": "Railsware Products Studio LLC",
   "dependencies": {
     "axios": ">=0.27"