# mailgun-stats

> A tool to export mailgun API stats

Latest version **1.0.0** (published 2020-12-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install mailgun-stats
pnpm add mailgun-stats
yarn add mailgun-stats
bun add mailgun-stats
```

Provides the command `mailgun-stats`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2020-12-19 |
| First published | 2020-12-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 14.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Michel Noel |
| Maintainers | mike1000000000 |

## Links

- npm: https://www.npmjs.com/package/mailgun-stats
- npm.io page: https://npm.io/package/mailgun-stats

## Dependencies (5)

- [colors](https://npm.io/package/colors.md) ^1.4.0
- [moment](https://npm.io/package/moment.md) ^2.25.3
- [minimist](https://npm.io/package/minimist.md) ^1.2.5
- [cli-table](https://npm.io/package/cli-table.md) ^0.3.1
- [superagent](https://npm.io/package/superagent.md) ^5.2.2

## Recent versions

- 1.0.0 (latest) — 2020-12-19

## README

# mailgun-stats

A simple tool to get your mailgun stats on the command line. You will first need an account here: ['https://www.mailgun.com']
 

## Prerequisites

Node and NPM need to be installed. These tools were built using Node v12.16.1 and NPM 6.13.4.

## Install

Using git (starting from an empty folder):
```
$ git clone https://github.com/mike1000000000/mailgun-stats.git .
$ npm install
```
**Note:** If you install mailgun-stats locally you can create a system link using `npm link` otherwise you will need to run `node mailgun-stats.js [command]` whenever issuing a command.

## Usage

In order to get started, you will need to get your mailgun API key and base URL.

You will find your Private API Key under `Settings -> API Keys` in the Mailgun dashboard.


The base URL will be either:

https://api.mailgun.net/v3   (For US region domains)  
or  
https://api.eu.mailgun.net/v3 (For EU region domains)  
  
  
Once you have these, edit the config.json file like this:
```
{
    "apiURL": "https://api.mailgun.net/v3/",
    "apiToken": "00000000000000000000000000000000-ffffffff-abcdefgh"
}
```

This will allow the tool to access your Mailgun API info.



## Syntax
```
mailgun-stats [command] [arguments]
```
 
  
Commands
***
##### allstats
Show a table of all domain stats. This will show the servers current date if no startdate/enddate is specified.

```
$ mailgun-stats allstats
```
 
Output:

```
┌────────────────────┬────────────┬──────────┬───────────┬──────────────┬──────────────┐
│ Domain             │ Date       │ Accepted │ Delivered │ Failure Temp │ Failure Perm │
├────────────────────┼────────────┼──────────┼───────────┼──────────────┼──────────────┤
│ mg.example.com     │ 2020-05-15 │ 15       │ 15        │ 1            │ 0            │
├────────────────────┼────────────┼──────────┼───────────┼──────────────┼──────────────┤
│ mail.host.ca       │ 2020-05-15 │ 5        │ 5         │ 0            │ 1            │
└────────────────────┴────────────┴──────────┴───────────┴──────────────┴──────────────┘
```
 
##### domain
Show a table of specifically named domain stats. 

```
$ mailgun-stats domain mg.example.com 
```

 
Output:
```
┌────────────────────┬────────────┬──────────┬───────────┬──────────────┬──────────────┐
│ Domain             │ Date       │ Accepted │ Delivered │ Failure Temp │ Failure Perm │
├────────────────────┼────────────┼──────────┼───────────┼──────────────┼──────────────┤
│ mg.example.com     │ 2020-05-15 │ 15       │ 15        │ 1            │ 0            │
└────────────────────┴────────────┴──────────┴───────────┴──────────────┴──────────────┘
```
**Note**: You can add more than one domain.  
 

   
Arguments
***

##### Startdate
Use `-s` or `--startdate` to output dates beginning on the specified date at 00:00:00 (yyyy-mm-dd). Default is current server day. If no end date specified will only return a single day.

##### Enddate
Use `-e` or `--enddate` to output dates ending on the specified date at 23:59:59 (yyyy-mm-dd).  Requires startdate to be used.

##### Rawdate
Use `-r` or `--rawdate` to provide the raw date output from the API. Defaults to "yyyy-mm-dd".

##### Verbose
Use `-v` or `--verbose` to show retrieved JSON strings and debugging info.
 
##### Help
Use `-h` or `--help` to show the help menu.
 
##### Version
Use `-V` or `--Version` (note case) to the show the version info.

##### Json
Use `-j` or `--json` Outputs results in JSON format only. 


---
### Warranty:

VENDOR MAKES NO WARRANTIES, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Written by Michel Noel © 2020

---
_Source: https://npm.io/package/mailgun-stats · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._