banshee/cloud-collection/cloud/mandrill/https/account

Mailchimp Transactional account

Returns the reputation of a Mailchimp Transactional account (formerly Mandrill), its hourly quota, and the emails it holds back because the quota is reached, read from its API with an API key that may only read the account. Three watches are offered, each one set on the probe.

Versions

Generic: the API of Mailchimp Transactional, version 1.4, the same for every account.

How it works

POST https://mandrillapp.com/api/1.4/users/info, the body {"key": "<the API key>"}, of type application/json.

{"username": "…", "created_at": "2021-03-04 10:00:00", "public_id": "…", "reputation": 82, "hourly_quota": 250,
 "backlog": 0, "stats": {"today": {…}, "last_7_days": {…}, …}}

reputation is a score from 0 to 100; Mailchimp Transactional calls 75 and above generally good.
hourly_quota is the most emails the account delivers in an hour; a higher reputation gets a higher quota. Emails beyond it are accepted and queued: backlog counts them.
A code 401 (the key wrong or revoked, or not allowed to call users/info) stops the collector misconfigured; any other code but 200 stops it unreachable.

Why the answer is declared free of tokens

The API takes its key in the JSON body only, and documents no other way to send it. A response to a body that carries a secret is secret, and nothing read from it could be returned: the call declares its answer free of tokens, public=true. The answer of users/info holds the figures of the account (its username, its public ID, its reputation, its quota and its statistics), and never the key. A part of the answer that held the key, as it is, in base64 or encoded for an address, would still be secret, and the collector would stop rather than return it.

Prerequisites

An API key of the account, made in Settings (+ New API Key), limited to the one API call users/info: a key may be restricted to a selection of calls, and with this one it can neither send an email nor read one. Its value goes in protocol:http:token, a secret variable: it only goes in the body of the request.
The poller reaches mandrillapp.com in HTTPS. Its certificate is issued by a public authority: the profile "Standard" trusts it.

Variables

None of its own.

Outputs

Name	Label	Unit	Per instance
`reputation`	Reputation	—	no
`hourly-quota`	Hourly quota	emails/h	no
`backlog`	Held by the quota	emails	no

Watches

Name	Title	Kind	Defaults	Checked by default
`low-reputation`	Reputation low	below, on `reputation`	warning under 75, critical under 50	yes
`low-quota`	Hourly quota low	below, on `hourly-quota`	no threshold: it raises nothing until one is set on the probe, under the volume the account must send in an hour	yes
`backlog`	Emails held by the quota	above, on `backlog`	warning above 0 for 3 runs: a burst the quota absorbs in a run does not raise	yes

Limits

One account per probe, the account of the key.
Not checked against a Mailchimp Transactional account. The route, its body, the fields of its answer and the code 401 are those of the public reference of the API (mailchimp.com/developer/transactional, "Get account info"); the restriction of a key to some calls is that of its "Fundamentals" page, which names the error of a call the key may not make.