deliverability

Embed

<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-report

Parameters

fromstringquery

tostringquery

testIdstringquery

senderConnectionIdstringquery

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/deliverability/placement-report" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "tests": 0,
  "byProvider": [
    {
      "provider": "google",
      "inbox": 0,
      "spam": 0,
      "missing": 0,
      "total": 0,
      "inboxRate": 0
    }
  ],
  "byDay": [
    {
      "day": "string",
      "inbox": 0,
      "spam": 0,
      "missing": 0
    }
  ],
  "bySender": [
    {
      "senderAddress": "string",
      "inbox": 0,
      "spam": 0,
      "missing": 0,
      "inboxRate": 0
    }
  ],
  "insights": [
    "string"
  ]
}

Schema

testsintegerrequired

byProviderByProviderItem[]required

Show child parameters

providerstringrequired

google | microsoft | other

inboxintegerrequired

spamintegerrequired

missingintegerrequired

totalintegerrequired

inboxRatenumberrequired

byDayobject[]required

Show child parameters

daystringrequired

inboxintegerrequired

spamintegerrequired

missingintegerrequired

bySenderobject[]required

Show child parameters

senderAddressstringrequired

inboxintegerrequired

spamintegerrequired

missingintegerrequired

inboxRatenumberrequired

insightsstring[]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-report

GEThttps://hermeticor.com/v1/deliverability/placement-providers

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/placement-providers" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "provider": "google",
      "seeds": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

providerstringrequired

google | microsoft | other

seedsintegerrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/deliverability/placement-report

5XX Default Response

Same as 4XX · GET /v1/deliverability/placement-report

GEThttps://hermeticor.com/v1/deliverability/placement-folders

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/placement-folders" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "folder": "string",
      "tests": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

folderstringrequired

testsintegerrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/deliverability/placement-report

5XX Default Response

Same as 4XX · GET /v1/deliverability/placement-report

DELETEhttps://hermeticor.com/v1/deliverability/placement-folders/{folder}

Parameters

folderstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/deliverability/placement-folders/{folder}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/deliverability/placement-report

5XX Default Response

Same as 4XX · GET /v1/deliverability/placement-report

POSThttps://hermeticor.com/v1/deliverability/content-score

Request body

application/json

subjectstring

textstring

htmlstring

{
  "subject": "",
  "text": "",
  "html": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/deliverability/content-score" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"subject":"","text":"","html":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "score": 0,
  "threshold": 0,
  "verdict": "pass",
  "rules": [
    {
      "id": "string",
      "points": 0,
      "description": "string"
    }
  ]
}

Schema

scorenumberrequired

thresholdnumberrequired

verdictstringrequired

pass | warn | fail

rulesRulesItem5[]required

Show child parameters

idstringrequired

pointsnumberrequired

descriptionstringrequired

4XX Default Response

Same as 4XX · GET /v1/deliverability/placement-report

5XX Default Response

Same as 4XX · GET /v1/deliverability/placement-report

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

Parameters

hoststringquery

ipstringquery

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/deliverability/rdns" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "results": [
    {
      "ip": "string",
      "ptr": [
        "string"
      ],
      "forwardConfirmed": true,
      "ok": true,
      "detail": "string"
    }
  ],
  "ok": true
}

Schema

resultsResultsItem3[]required

Show child parameters

ipstringrequired

ptrstring[]required

forwardConfirmedbooleanrequired

okbooleanrequired

detailstring

okbooleanrequired

4XX Default Response

Same as 4XX · GET /v1/deliverability/placement-report

5XX Default Response

Same as 4XX · GET /v1/deliverability/placement-report

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

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/deliverability/agent" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "autoPause": true,
  "bounceRate": 0,
  "complaintRate": 0,
  "minSample": 0
}

Schema

autoPausebooleanrequired

bounceRatenumberrequired

complaintRatenumberrequired

minSampleintegerrequired

4XX Default Response

Same as 4XX · GET /v1/deliverability/placement-report

5XX Default Response

Same as 4XX · GET /v1/deliverability/placement-report

PUThttps://hermeticor.com/v1/deliverability/agent

Request body

application/json

autoPausebooleanrequired

bounceRatenumberrequired

complaintRatenumberrequired

minSampleintegerrequired

{
  "autoPause": true,
  "bounceRate": 0,
  "complaintRate": 0,
  "minSample": 0
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/deliverability/agent" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"autoPause":true,"bounceRate":0,"complaintRate":0,"minSample":0}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/deliverability/agent

4XX Default Response

Same as 4XX · GET /v1/deliverability/placement-report

5XX Default Response

Same as 4XX · GET /v1/deliverability/placement-report

POSThttps://hermeticor.com/v1/deliverability/agent/run-now

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/deliverability/agent/run-now" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "evaluated": 0,
  "paused": [
    {
      "connectionId": "string",
      "reason": "string"
    }
  ]
}

Schema

evaluatedintegerrequired

pausedobject[]required

Show child parameters

connectionIdstringrequired

reasonstringrequired

4XX Default Response

Same as 4XX · GET /v1/deliverability/placement-report

5XX Default Response

Same as 4XX · GET /v1/deliverability/placement-report

Next part

Updated Nov 8, 2026

Was this page helpful?