MillionSend.Deliverability (MillionSend v0.5.0)

Account-level deliverability score over the trailing window.

Scores are 0–10 with one decimal; score, band, content_score and outcome_score are nil when there is not enough data to compute them. band ("excellent" | "good" | "needs_attention" | "at_risk") and guardrail_status ("ok" | "warning" | "paused") are plain strings so future wire values never break decoding.

{:ok, report} = MillionSend.Deliverability.get()

Summary

Functions

get(client \\ MillionSend.client())

GET /deliverability

Functions

get(client \\ MillionSend.client())

@spec get(MillionSend.Client.t()) ::
  {:ok,
   %MillionSend.Deliverability{
     band: term(),
     complaint_rate: term(),
     content_score: term(),
     emails_sent: term(),
     guardrail_status: term(),
     hard_bounce_rate: term(),
     insufficient_outcome_data: term(),
     object: term(),
     outcome_score: term(),
     score: term(),
     score_version: term(),
     scored_recipients: term(),
     window_days: term()
   }}
  | {:error, MillionSend.Error.t()}

GET /deliverability