analytics

Embed

<a href="https://hermeticor.com/docs/ref-analytics"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/83d044a8-2e41-46eb-a741-5043d696d3f3/social-card.svg?v=3e7ae33eec8b" alt="analytics" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/analytics/content-slots

Impressions per dynamic content slot and per matching rule

Parameters

fromstringqueryrequired

tostringqueryrequired

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/analytics/content-slots?from=<from>&to=<to>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "key": "string",
      "name": "string",
      "impressions": 0,
      "byRule": [
        {
          "matched": "string",
          "impressions": 0
        }
      ]
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

keystringrequired

namestringrequired

impressionsintegerrequired

byRuleobject[]required

Show child parameters

matchedstringrequired

impressionsintegerrequired

nextCursorstringrequired

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/analytics/content-slots

GEThttps://hermeticor.com/v1/analytics/sources/{kind}/{id}/links

Clicks per link for a campaign, journey or sequence; pass stepKey for one action

Parameters

stepKeystringquery

variantKeystringquery

byVariantstringquery

true | false

fromstringquery

tostringquery

kindstringpathrequired

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "rows": [
    {
      "url": "string",
      "clicks": 0,
      "uniqueClicks": 0,
      "variantKey": "string"
    }
  ]
}

Schema

rowsobject[]required

Show child parameters

urlstringrequired

clicksintegerrequired

uniqueClicksintegerrequired

variantKeystring

4XX Default Response

Same as 4XX · GET /v1/analytics/content-slots

5XX Default Response

Same as 4XX · GET /v1/analytics/content-slots

GEThttps://hermeticor.com/v1/analytics/sources/{kind}/{id}/actions

Sent, delivered, bounced, unique opens and clicks per action of a journey or sequence

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

kindstringpathrequired

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "stepKey": "string",
      "sent": 0,
      "delivered": 0,
      "bounced": 0,
      "failed": 0,
      "openedUnique": 0,
      "clickedUnique": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

stepKeystringrequired

sentintegerrequired

deliveredintegerrequired

bouncedintegerrequired

failedintegerrequired

openedUniqueintegerrequired

clickedUniqueintegerrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/analytics/content-slots

5XX Default Response

Same as 4XX · GET /v1/analytics/content-slots

GEThttps://hermeticor.com/v1/analytics/deliveries/export

Delivery-level export with open and click counts; format=csv returns the CSV text in `csv`

Parameters

sourceKindstringquery

sourceIdstringquery

stepKeystringquery

statusstringquery

fromstringqueryrequired

tostringqueryrequired

formatstringquery

json | csv = json

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/analytics/deliveries/export?from=<from>&to=<to>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "profileId": "string",
      "channel": "string",
      "destination": "string",
      "status": "string",
      "sourceKind": "string",
      "sourceId": "string",
      "stepKey": "string",
      "variantKey": "string",
      "subject": "string",
      "sentAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z",
      "opens": 0,
      "clicks": 0
    }
  ],
  "truncated": true,
  "csv": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

profileIdstringrequired

channelstringrequired

destinationstringrequired

statusstringrequired

sourceKindstringrequired

sourceIdstringrequired

stepKeystringrequired

variantKeystringrequired

subjectstringrequired

sentAtstringrequired

createdAtstringrequired

opensintegerrequired

clicksintegerrequired

truncatedbooleanrequired

csvstringrequired

4XX Default Response

Same as 4XX · GET /v1/analytics/content-slots

5XX Default Response

Same as 4XX · GET /v1/analytics/content-slots

GEThttps://hermeticor.com/v1/analytics/dashboards

Dashboards; ?archived=true lists the archived ones

Parameters

archivedstringquery

true | false

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "widgets": [
        {
          "id": "string",
          "reportId": "string",
          "title": "string",
          "size": "half"
        }
      ],
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z",
      "ownerId": null,
      "visibility": "shared"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem149[]required

Show child parameters

idstringrequired

namestringrequired

widgetsWidgetsItem[]required

Show child parameters

idstringrequired

reportIdstringrequired

titlestring

sizestringrequired

half | full = half

createdAtstringrequired

updatedAtstringrequired

ownerIdstringrequired

= null

visibilitystringrequired

shared | private = shared

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/analytics/content-slots

5XX Default Response

Same as 4XX · GET /v1/analytics/content-slots

POSThttps://hermeticor.com/v1/analytics/dashboards

Request body

application/json

namestringrequired

widgetsWidgetsItem2[]

= []

Show child parameters

reportIdstringrequired

titlestring

sizestring

half | full = half

{
  "name": "string",
  "widgets": []
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/analytics/dashboards" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","widgets":[]}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "name": "string",
  "widgets": [
    {
      "id": "string",
      "reportId": "string",
      "title": "string",
      "size": "half"
    }
  ],
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "ownerId": null,
  "visibility": "shared"
}

Schema

idstringrequired

namestringrequired

widgetsWidgetsItem[]required

Show child parameters

idstringrequired

reportIdstringrequired

titlestring

sizestringrequired

half | full = half

createdAtstringrequired

updatedAtstringrequired

ownerIdstringrequired

= null

visibilitystringrequired

shared | private = shared

4XX Default Response

Same as 4XX · GET /v1/analytics/content-slots

5XX Default Response

Same as 4XX · GET /v1/analytics/content-slots

POSThttps://hermeticor.com/v1/analytics/dashboards/batch/archive

Request body

application/json

idsstring[]required

{
  "ids": [
    "string"
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/analytics/dashboards/batch/archive" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "count": 0
}

Schema

countintegerrequired

4XX Default Response

Same as 4XX · GET /v1/analytics/content-slots

5XX Default Response

Same as 4XX · GET /v1/analytics/content-slots

POSThttps://hermeticor.com/v1/analytics/dashboards/batch/restore

Request body

application/json

idsstring[]required

{
  "ids": [
    "string"
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/analytics/dashboards/batch/restore" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/analytics/dashboards/batch/archive

4XX Default Response

Same as 4XX · GET /v1/analytics/content-slots

5XX Default Response

Same as 4XX · GET /v1/analytics/content-slots

Next part

Updated Nov 8, 2026

Was this page helpful?