campaigns

Embed

<a href="https://hermeticor.com/docs/ref-campaigns"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/7b5e5778-2701-4b75-820c-3417186ab185/social-card.svg?v=3e7ae33eec8b" alt="campaigns" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/reports/{id}

One campaign report: domains, locations by country and region, links, abuse, revenue, rates, list-average and industry comparison, and the share link

Parameters

industrystringquery

= all

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/reports/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "campaignId": "string",
  "sent": 0,
  "domains": [
    {
      "domain": "string",
      "sent": 0,
      "opened": 0,
      "clicked": 0,
      "bounced": 0
    }
  ],
  "locations": [
    {
      "network": "string",
      "opens": 0
    }
  ],
  "countries": [],
  "devices": [
    {
      "device": "string",
      "opens": 0,
      "clicks": 0
    }
  ],
  "links": [
    {
      "url": "string",
      "total": 0,
      "unique": 0
    }
  ],
  "abuse": [
    {
      "profileId": "string",
      "destination": "string",
      "at": "2024-01-01T00:00:00Z"
    }
  ],
  "unsubscribeReasons": [
    {
      "reason": "string",
      "count": 0
    }
  ],
  "revenue": {
    "orders": 0,
    "revenueMinor": 0
  },
  "delivered": 0,
  "opens": {
    "total": 0,
    "unique": 0,
    "last": "2024-01-01T00:00:00Z"
  },
  "clicks": {
    "total": 0,
    "unique": 0,
    "last": "2024-01-01T00:00:00Z"
  },
  "bounces": {
    "hard": 0,
    "soft": 0
  },
  "unsubscribed": 0,
  "complaints": 0,
  "forwards": 0,
  "rates": {
    "deliveryRate": 0,
    "openRate": 0,
    "clickRate": 0,
    "clickToOpenRate": 0,
    "bounceRate": 0,
    "unsubscribeRate": 0,
    "complaintRate": 0
  },
  "comparison": {
    "listAverage": {
      "deliveryRate": 0,
      "openRate": 0,
      "clickRate": 0,
      "clickToOpenRate": 0,
      "bounceRate": 0,
      "unsubscribeRate": 0,
      "complaintRate": 0
    },
    "industry": {
      "key": "string",
      "label": "string",
      "open": [
        0
      ],
      "click": [
        0
      ],
      "unsubscribe": [
        0
      ],
      "bounce": [
        0
      ],
      "note": "string"
    }
  },
  "regions": [
    {
      "country": "string",
      "region": "string",
      "opens": 0,
      "people": 0
    }
  ],
  "shareReport": {
    "url": "string"
  }
}

Schema

campaignIdstringrequired

sentintegerrequired

domainsobject[]required

Show child parameters

domainstringrequired

sentnumberrequired

openednumberrequired

clickednumberrequired

bouncednumberrequired

locationsobject[]required

Show child parameters

networkstringrequired

opensnumberrequired

countriesobject[]required

= []

Show child parameters

countrystringrequired

opensnumberrequired

devicesobject[]required

Show child parameters

devicestringrequired

opensnumberrequired

clicksnumberrequired

linksobject[]required

Show child parameters

urlstringrequired

totalnumberrequired

uniquenumberrequired

abuseobject[]required

Show child parameters

profileIdstringrequired

destinationstringrequired

atstringrequired

unsubscribeReasonsobject[]required

Show child parameters

reasonstringrequired

countnumberrequired

revenueobjectrequired

Show child parameters

ordersnumberrequired

revenueMinornumberrequired

deliveredintegerrequired

opensobjectrequired

Show child parameters

totalintegerrequired

uniqueintegerrequired

laststringrequired

clicksobjectrequired

Show child parameters

totalintegerrequired

uniqueintegerrequired

laststringrequired

bouncesobjectrequired

Show child parameters

hardintegerrequired

softintegerrequired

unsubscribedintegerrequired

complaintsintegerrequired

forwardsnumberrequired

ratesobjectrequired

Show child parameters

deliveryRatenumberrequired

openRatenumberrequired

clickRatenumberrequired

clickToOpenRatenumberrequired

bounceRatenumberrequired

unsubscribeRatenumberrequired

complaintRatenumberrequired

comparisonobjectrequired

Show child parameters

listAverageobjectrequired

Show child parameters

deliveryRatenumberrequired

openRatenumberrequired

clickRatenumberrequired

clickToOpenRatenumberrequired

bounceRatenumberrequired

unsubscribeRatenumberrequired

complaintRatenumberrequired

industryobjectrequired

Show child parameters

keystringrequired

labelstringrequired

opennumber[]required

clicknumber[]required

unsubscribenumber[]required

bouncenumber[]required

notestringrequired

regionsobject[]required

Show child parameters

countrystringrequired

regionstringrequired

opensintegerrequired

peopleintegerrequired

shareReportobjectrequired

Show child parameters

urlstringrequired

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/reports/{id}

GEThttps://hermeticor.com/v1/reports/{id}/advice

Plain-language advice on one campaign's open, click, bounce and spam rates

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/reports/{id}/advice" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "campaignId": "string",
  "items": [
    {
      "tone": "good",
      "message": "string"
    }
  ]
}

Schema

campaignIdstringrequired

itemsobject[]required

Show child parameters

tonestringrequired

good | warn | info

messagestringrequired

4XX Default Response

Same as 4XX · GET /v1/reports/{id}

5XX Default Response

Same as 4XX · GET /v1/reports/{id}

GEThttps://hermeticor.com/v1/reports/{id}/click-details

Parameters

urlstringqueryrequired

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/reports/{id}/click-details?url=<url>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "url": "string",
  "total": 0,
  "unique": 0
}

Schema

urlstringrequired

totalnumberrequired

uniquenumberrequired

4XX Default Response

Same as 4XX · GET /v1/reports/{id}

5XX Default Response

Same as 4XX · GET /v1/reports/{id}

GEThttps://hermeticor.com/v1/reports/{id}/links

Every link: clicks, unique clickers, last click, share of all clicks, and the split per A/B variant

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/reports/{id}/links" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "url": "string",
      "clicks": 0,
      "unique": 0,
      "lastClick": "2024-01-01T00:00:00Z",
      "clickShare": 0,
      "uniqueShare": 0,
      "variants": [
        {
          "variantKey": "string",
          "clicks": 0,
          "unique": 0
        }
      ]
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

urlstringrequired

clicksintegerrequired

uniqueintegerrequired

lastClickstringrequired

clickSharenumberrequired

uniqueSharenumberrequired

variantsobject[]required

Show child parameters

variantKeystringrequired

clicksintegerrequired

uniqueintegerrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/reports/{id}

5XX Default Response

Same as 4XX · GET /v1/reports/{id}

GEThttps://hermeticor.com/v1/reports/{id}/unsubscribed

Who unsubscribed from this campaign, when, and how (link, List-Unsubscribe header, reply ...)

Parameters

limitintegerquery

= 50

cursorstringquery

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/reports/{id}/unsubscribed" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "profileId": "string",
      "email": "string",
      "reason": "string",
      "at": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

profileIdstringrequired

emailstringrequired

reasonstringrequired

atstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/reports/{id}

5XX Default Response

Same as 4XX · GET /v1/reports/{id}

GEThttps://hermeticor.com/v1/reports/{id}/share-stats

Views, unique visitors, referrers and link clicks of the public share link

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/reports/{id}/share-stats" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "campaignId": "string",
  "views": 0,
  "uniqueVisitors": 0,
  "clicks": 0,
  "lastViewAt": "2024-01-01T00:00:00Z",
  "referrers": [
    {
      "key": "string",
      "count": 0
    }
  ],
  "links": [
    {
      "url": "string",
      "clicks": 0
    }
  ]
}

Schema

campaignIdstringrequired

viewsintegerrequired

uniqueVisitorsintegerrequired

clicksintegerrequired

lastViewAtstringrequired

referrersItemsItem13[]required

Show child parameters

keystringrequired

countintegerrequired

linksobject[]required

Show child parameters

urlstringrequired

clicksintegerrequired

4XX Default Response

Same as 4XX · GET /v1/reports/{id}

5XX Default Response

Same as 4XX · GET /v1/reports/{id}

Next part

Updated Nov 8, 2026

Was this page helpful?