API referenceDeliverability
Deliverability overview
GET
/deliverability/overviewCounts, rates and health against the SES bounce and complaint thresholds for the period, compared with the previous one, with estimated SES cost, sandbox status and DNS advisor summary.
Authorization
apiKey AuthorizationBearer <token>
A project API key: Authorization: Bearer s0_…
In: header
Query Parameters
from?string
Match
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$Format
dateto?string
Match
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$Format
datedays?integer
Range
1 <= value <= 366domain?string
Length
1 <= length <= 253isp?string
Value in
- "gmail"
- "outlook"
- "yahoo"
- "icloud"
- "other"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/deliverability/overview"{ "object": "deliverability_overview", "period": { "from": "2019-08-24", "to": "2019-08-24", "days": 1 }, "counts": { "sent": 0, "delivered": 0, "delivery_delayed": 0, "bounced_hard": 0, "bounced_soft": 0, "bounced_undetermined": 0, "complained": 0, "opened": 0, "opened_unique": 0, "clicked": 0, "clicked_unique": 0, "rejected": 0, "failed": 0 }, "rates": { "delivery_rate": 0, "bounce_rate": 0, "soft_bounce_rate": 0, "complaint_rate": 0, "open_rate": 0, "click_rate": 0 }, "health": { "status": "healthy", "bounce": "healthy", "complaint": "healthy", "low_volume": true, "basis": "ses", "thresholds": { "bounce_rate": { "warning": 0, "critical": 0 }, "complaint_rate": { "warning": 0, "critical": 0 } } }, "previous": { "counts": { "sent": 0, "delivered": 0, "delivery_delayed": 0, "bounced_hard": 0, "bounced_soft": 0, "bounced_undetermined": 0, "complained": 0, "opened": 0, "opened_unique": 0, "clicked": 0, "clicked_unique": 0, "rejected": 0, "failed": 0 }, "rates": { "delivery_rate": 0, "bounce_rate": 0, "soft_bounce_rate": 0, "complaint_rate": 0, "open_rate": 0, "click_rate": 0 }, "health": { "status": "healthy", "bounce": "healthy", "complaint": "healthy", "low_volume": true, "basis": "ses", "thresholds": { "bounce_rate": { "warning": 0, "critical": 0 }, "complaint_rate": { "warning": 0, "critical": 0 } } }, "period": { "from": "2019-08-24", "to": "2019-08-24", "days": 1 } }, "cost": { "currency": "USD", "emails_billed": 0, "attachment_bytes": 0, "emails_received": 0, "sending_usd": 0, "outbound_data_usd": 0, "receiving_usd": 0, "total_usd": 0, "fixed_monthly_usd": 0, "pricing": { "outbound_per_thousand_usd": 0, "outbound_data_per_gb_usd": 0, "inbound_per_thousand_usd": 0, "inbound_chunk_per_thousand_usd": 0 } }, "connection": { "id": "string", "provider": "ses", "resets_at": "2019-08-24T14:15:22Z", "sent_source": "cloudflare_analytics", "region": "string", "status": "string", "sandbox_status": "unknown", "sending_enabled": true, "max_24_hour_send": 0, "max_send_rate": 0, "sent_last_24_hours": 0 }, "suppressions": { "count": 0, "shared_with_projects": 0 }, "dns": { "healthy": 0, "warning": 0, "critical": 0, "unchecked": 0 }}Pin the Cloudflare data plane PUT
Dashboard only (owners and admins), Cloudflare connections. Keeps the connection on one data-plane version (default: the deployed one), or `opt_out` of every upgrade. Upgrades and redeploys to another version are refused while pinned; rollback still works. Nothing is deployed.
Deliverability by day GET
Next Page