deliverability

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-deliverability"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/cdde641f-86e7-4af2-8e6d-630d445560be/social-card.svg?v=3e7ae33eec8b" alt="deliverability" width="600" height="315"></a>
GEThttps://hermeticor.com/v1/deliverability/placement-tests/{id}/ip-analytics

Sending addresses behind a placement test (from the sender domain SPF) with reverse-DNS and blocklist results; shared provider addresses are named, not checked

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/deliverability/placement-tests/{id}/ip-analytics" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "domain": "string",
  "spf": "string",
  "providers": [
    "string"
  ],
  "ips": [
    {
      "ip": "string",
      "source": "string",
      "range": "string",
      "ptr": {
        "ip": "string",
        "ptr": [
          "string"
        ],
        "forwardConfirmed": true,
        "ok": true,
        "detail": "string"
      },
      "listed": true,
      "listings": [
        {
          "zone": "string",
          "code": "string"
        }
      ],
      "errors": [
        "string"
      ]
    }
  ],
  "notes": [
    "string"
  ]
}
Schema
domainstringrequired
spfstringrequired
providersstring[]required
ipsobject[]required
Show child parameters
ipstringrequired
sourcestringrequired
rangestringrequired
ptrobjectrequired
Show child parameters
ipstringrequired
ptrstring[]required
forwardConfirmedbooleanrequired
okbooleanrequired
detailstring
listedbooleanrequired
listingsobject[]required
Show child parameters
zonestringrequired
codestringrequired
errorsstring[]required
notesstring[]required
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /v1/deliverability/placement-tests/{id}/ip-analytics

GEThttps://hermeticor.com/v1/deliverability/agents

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/deliverability/agents" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "autoPause": true,
      "bounceRate": 0,
      "complaintRate": 0,
      "minSample": 0
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem185[]required
Show child parameters
idstringrequired
autoPausebooleanrequired
bounceRatenumberrequired
complaintRatenumberrequired
minSampleintegerrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/deliverability/placement-tests/{id}/ip-analytics

5XX Default Response

Same as 4XX · GET /v1/deliverability/placement-tests/{id}/ip-analytics

GEThttps://hermeticor.com/v1/deliverability/agents/{agentId}

Parameters

agentIdstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/deliverability/agents/{agentId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "id": "string",
  "autoPause": true,
  "bounceRate": 0,
  "complaintRate": 0,
  "minSample": 0
}
Schema
idstringrequired
autoPausebooleanrequired
bounceRatenumberrequired
complaintRatenumberrequired
minSampleintegerrequired
4XX Default Response

Same as 4XX · GET /v1/deliverability/placement-tests/{id}/ip-analytics

5XX Default Response

Same as 4XX · GET /v1/deliverability/placement-tests/{id}/ip-analytics

DELETEhttps://hermeticor.com/v1/deliverability/agents/{agentId}

Turn the agent off (it stops pausing mailboxes); its limits are kept

Parameters

agentIdstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/deliverability/agents/{agentId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/deliverability/agents/{agentId}

4XX Default Response

Same as 4XX · GET /v1/deliverability/placement-tests/{id}/ip-analytics

5XX Default Response

Same as 4XX · GET /v1/deliverability/placement-tests/{id}/ip-analytics

PATCHhttps://hermeticor.com/v1/deliverability/agents/{agentId}

Parameters

agentIdstringpathrequired

Request body

application/json
autoPauseboolean
bounceRatenumber
complaintRatenumber
minSampleinteger
{
  "autoPause": true,
  "bounceRate": 0,
  "complaintRate": 0,
  "minSample": 0
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/deliverability/agents/{agentId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"autoPause":true,"bounceRate":0,"complaintRate":0,"minSample":0}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/deliverability/agents/{agentId}

4XX Default Response

Same as 4XX · GET /v1/deliverability/placement-tests/{id}/ip-analytics

5XX Default Response

Same as 4XX · GET /v1/deliverability/placement-tests/{id}/ip-analytics

GEThttps://hermeticor.com/v1/deliverability/placement-tests/{id}/headers

Delivery-path headers of each seed copy (IMAP and Gmail seeds)

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/deliverability/placement-tests/{id}/headers" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "seedAddress": "string",
      "folder": "string",
      "headers": [
        "string"
      ]
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
seedAddressstringrequired
folderstringrequired
headersstring[]required
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/deliverability/placement-tests/{id}/ip-analytics

5XX Default Response

Same as 4XX · GET /v1/deliverability/placement-tests/{id}/ip-analytics

Updated