Skip to content

mail_reputation_get

Current sender-reputation status for the product: hard-bounce and complaint rates over the rolling window, the sample volume, whether sends are throttled, the tripped metric, and the configured thresholds

Tool

mail_reputation_get

Current sender-reputation status for the product: hard-bounce and complaint rates over the rolling window, the sample volume, whether sends are throttled, the tripped metric, and the configured thresholds

Current sender-reputation status for the product: hard-bounce and complaint rates over the rolling window, the sample volume, whether sends are throttled, the tripped metric, and the configured thresholds

Behavior

HTTP
GET /mail/reputation

Arguments

No arguments.

Response

Field
Type
Always
Description
gated
boolean
•
True when sending is currently throttled because a rate crossed its threshold
volume
integer
•
Emails sent in the window — the denominator of both rates
complaints
integer
•
Spam complaints in the window
thresholds
object
•
The configured limits the rates above are compared against
window_days
integer
•
Length in days of the rolling window the rates below are measured over
hard_bounces
integer
•
Hard bounces in the window
complaint_rate
number
•
Complaints divided by volume, as a ratio 0-1 (0.001 = 0.1%)
tripped_metric
string
•
Which rate crossed its threshold, or null when nothing did
hard_bounce_rate
number
•
Hard bounces divided by volume, as a ratio 0-1 (0.05 = 5%)

Try it

Current sender-reputation status for the product: hard-bounce and complaint rates over the rolling window, the sample volume, whether sends are throttled, the tripped metric, and the configured thresholds.

When to use

Current sender-reputation status for the product: hard-bounce and complaint rates over the rolling window, the sample volume, whether sends are throttled, the tripped metric, and the configured thresholds

Example

Ask your agent something like this:

Current sender-reputation status for the product: hard-bounce and complaint rates over the rolling window, the sample volume, whether sends are throttled, the tripped metric, and the configured thresholds.

The agent will invoke mail_reputation_get with these arguments:

{}

Esc

Start typing to search the docs.

↑↓navigate↵select