Merge pull request #41 from mailsac/add_section_for_managing_api_keys

Add api usage and mail stats documentation

help/account_management/account_management.rst

@@ -1,8 +1,10 @@
-.. _doc_account_management:
-
 .. _Dashboard: https://mailsac.com/dashboard
 .. _`Manage Account Details`: https://mailsac.com/account
+.. _`REST API`: https://mailsac.com/api
+.. _`API Keys`: https://mailsac.com/api-keys
+.. _`API Use`: https://mailsac.com/usage
 
+.. _doc_account_management:
 
 Account Management
 ==================
@@ -27,6 +29,79 @@ reset email.
 
 .. _sec_account_deletion:
 
+API Key Management
+------------------
+
+API keys are used to authenticate to the `REST API`_,
+:ref:`Email Capture <doc_email_capture>`, :ref:`SMTP <sec_sendingmail_smtp>`,
+and :ref:`POP3 <sec_reading_mail_pop3>`.
+
+API Keys can be created, viewed, and deleted `API Keys`_ section of the
+Dashboard_.
+
+Multiple Named API Keys
+^^^^^^^^^^^^^^^^^^^^^^^
+
+For teams, using unique API Keys, can help with access control, monitoring
+usage, and ensuring a unique API Key in each environment.
+
+To create a named API key, go to the `API Keys`_ from the Dashboard_. Enter a
+name for the API Key and select *Generate new API key*.
+
+.. figure:: add_named_key.png
+   :align: center
+   :width: 400px
+
+   Create new name API key
+
+API Usage
+---------
+
+API calls are calculated based on the following service usage:
+
+- `REST API`_ calls
+- Messages sent to the :ref:`Email Capture Service <doc_email_capture>`
+- Messages forwarded to :ref:`Slack <sec_forward_to_slack>`
+- Messages forwarded to a :ref:`Webhook <sec_webhook_forwarding>`
+- Messages forwarded to a :ref:`WebSocket <sec_websocket_forwarding>`
+
+View API Usage
+^^^^^^^^^^^^^^
+
+API Usage can be viewed by selecting `API Usage`_ from the Dashboard_. Current
+month usage and historical usage is available. Breakdown by API Key and service
+is visible by hovering the mouse over the bar graph in Monthly API Usage.
+
+.. figure:: current_month_api_usage.png
+   :align: center
+   :width: 400px
+
+   Current Month API Usage
+
+.. figure:: monthly_api_usage.png
+   :align: center
+   :width: 400px
+
+   Monthly API Usage
+
+Message Statistics
+------------------
+
+Monthly summaries of the following statistics are available per custom domain
+and account. Message statistics can be viewed by selecting `API Usage`_ from the
+Dashboard_.
+
+- Inbound Message Counts
+- Outbound Message Counts
+- Inbound Bandwidth
+- Outbound Bandwidth
+
+.. figure:: outbound_message_stats.png
+   :align: center
+   :width: 400px
+
+   Monthly outbound message count
+
 Account Deletion
 ----------------
 

services/email_capture/email_capture.rst

@@ -1,10 +1,10 @@
-.. _doc_email_capture:
-
 .. _Mailsac website: https://mailsac.com
 .. _Mailsac API: https://mailsac.com/api
 
+.. _doc_email_capture:
+
 Email Capture
-===============
+=============
 
 Email Capture is the service that allows Mailsac to act as a fake SMTP
 server. Email messages sent using Email Capture will not be delivered to