API reference · Native API (v1)
Platform deliverability report (platform team only)
GET
https://api.pidgely.com/v1/platform/deliverabilityRead-only deliverability of the platform (platform team only): bounce and complaint rates per domain and stream, deferred apart, DNS of the sending domains, blocklists and PTR of the sending IPs (own MTA and relay) and the alert list. Limits can be lowered with bounce_rate, complaint_rate, min_outcomes, min_delivered and min_bounced to force a test alert. Needs a full API key of a platform organisation; any other key gets 403.
Authorization: Bearer pdg_…. An API key with the full scope.
Request
curl -X GET 'https://api.pidgely.com/v1/platform/deliverability' \
-H "Authorization: Bearer $PIDGELY_API_KEY"Response
200 OK with a JSON object.
Errors
Native routes return {"error": {"code", "message", "field", "request_id"}}. See Errors.
| Status | Code | When |
|---|---|---|
| 401 | missing_api_key |
No Authorization: Bearer header. |
| 403 | invalid_api_key, insufficient_scope |
The key is invalid or lacks the scope. |
| 404 | not_found |
The resource does not exist in this account. |
| 422 | validation_error |
A field is missing or invalid; field names it. |
| 429 | rate_limited, daily_quota_exceeded |
Too many requests, or the Free plan quota is used up. |