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

Runs every widget report; a failing widget carries its own error

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "name": "string",
  "widgets": [
    {
      "id": "string",
      "reportId": "string",
      "title": "string",
      "size": "half",
      "reportName": "string",
      "run": {
        "kind": "string",
        "result": {}
      },
      "error": "string"
    }
  ]
}

Schema

idstringrequired

namestringrequired

widgetsobject[]required

Show child parameters

idstringrequired

reportIdstringrequired

titlestring

sizestringrequired

half | full = half

reportNamestringrequired

runobjectrequired

Show child parameters

kindstringrequired

resultrequired

errorstringrequired

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

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

Customers grouped by how recently and how often they ordered (champions, at risk, lost ...); needs 25 buyers

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "orderEvent": "string",
  "customers": 0,
  "minCustomers": 0,
  "enough": true,
  "reason": "string",
  "groups": [
    {
      "key": "string",
      "label": "string",
      "meaning": "string",
      "customers": 0,
      "revenueMinor": 0
    }
  ]
}

Schema

orderEventstringrequired

customersintegerrequired

minCustomersintegerrequired

enoughbooleanrequired

reasonstringrequired

groupsobject[]required

Show child parameters

keystringrequired

labelstringrequired

meaningstringrequired

customersintegerrequired

revenueMinorintegerrequired

4XX Default Response

Same as 4XX · GET /v1/analytics/dashboards/{id}/run

5XX Default Response

Same as 4XX · GET /v1/analytics/dashboards/{id}/run

GEThttps://hermeticor.com/v1/analytics/customer-insights

Buyers, repeat rate, order value, days between orders, new versus returning buyers and customers at risk

Parameters

daysintegerquery

= 90

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/analytics/customer-insights" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "orderEvent": "string",
  "days": 0,
  "buyers": 0,
  "repeatBuyers": 0,
  "repeatRate": 0,
  "orders": 0,
  "revenueMinor": 0,
  "avgOrderMinor": 0,
  "avgOrdersPerBuyer": 0,
  "avgDaysBetweenOrders": 0,
  "newBuyers": 0,
  "returningBuyers": 0,
  "newRevenueMinor": 0,
  "returningRevenueMinor": 0,
  "atRisk": 0
}

Schema

orderEventstringrequired

daysintegerrequired

buyersintegerrequired

repeatBuyersintegerrequired

repeatRatenumberrequired

ordersintegerrequired

revenueMinorintegerrequired

avgOrderMinorintegerrequired

avgOrdersPerBuyernumberrequired

avgDaysBetweenOrdersnumberrequired

newBuyersintegerrequired

returningBuyersintegerrequired

newRevenueMinorintegerrequired

returningRevenueMinorintegerrequired

atRiskintegerrequired

4XX Default Response

Same as 4XX · GET /v1/analytics/dashboards/{id}/run

5XX Default Response

Same as 4XX · GET /v1/analytics/dashboards/{id}/run

GEThttps://hermeticor.com/v1/analytics/deliverability-by-domain

Email delivery, bounce, complaint and open rates per recipient mailbox domain

Parameters

fromstringqueryrequired

tostringqueryrequired

limitintegerquery

= 25

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "rows": [
    {
      "domain": "string",
      "sent": 0,
      "delivered": 0,
      "bounced": 0,
      "complained": 0,
      "opened": 0,
      "clicked": 0,
      "deliveryRate": 0,
      "bounceRate": 0,
      "complaintRate": 0,
      "openRate": 0
    }
  ],
  "truncated": true
}

Schema

rowsobject[]required

Show child parameters

domainstringrequired

sentintegerrequired

deliveredintegerrequired

bouncedintegerrequired

complainedintegerrequired

openedintegerrequired

clickedintegerrequired

deliveryRatenumberrequired

bounceRatenumberrequired

complaintRatenumberrequired

openRatenumberrequired

truncatedbooleanrequired

4XX Default Response

Same as 4XX · GET /v1/analytics/dashboards/{id}/run

5XX Default Response

Same as 4XX · GET /v1/analytics/dashboards/{id}/run

GEThttps://hermeticor.com/v1/ad-spend/ad-products

Product sales per ad: units, orders and line revenue for orders tagged with the ad id, campaign key or platform

Parameters

fromstringqueryrequired

tostringqueryrequired

platformstringquery

campaignKeystringquery

adRefstringquery

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/ad-spend/ad-products?from=<from>&to=<to>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "productId": "string",
      "title": "string",
      "currency": "string",
      "units": 0,
      "orders": 0,
      "revenueMinor": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

productIdstringrequired

titlestringrequired

currencystringrequired

unitsnumberrequired

ordersnumberrequired

revenueMinornumberrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/analytics/dashboards/{id}/run

5XX Default Response

Same as 4XX · GET /v1/analytics/dashboards/{id}/run

GEThttps://hermeticor.com/v1/landing-pages/{id}/clicks

Links clicked on a hosted page

Parameters

daysintegerquery

= 30

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "days": 0,
  "total": 0,
  "items": [
    {
      "url": "string",
      "clicks": 0
    }
  ]
}

Schema

daysnumberrequired

totalnumberrequired

itemsobject[]required

Show child parameters

urlstringrequired

clicksnumberrequired

4XX Default Response

Same as 4XX · GET /v1/analytics/dashboards/{id}/run

5XX Default Response

Same as 4XX · GET /v1/analytics/dashboards/{id}/run

GEThttps://hermeticor.com/v1/landing-pages/{id}/revenue

Orders and revenue credited to a hosted page, with revenue per visit

Parameters

daysintegerquery

= 30

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "days": 0,
  "visits": 0,
  "signups": 0,
  "totals": [
    {
      "currency": "string",
      "orders": 0,
      "revenueMinor": 0,
      "revenuePerVisitMinor": 0
    }
  ],
  "daily": [
    {
      "day": "string",
      "currency": "string",
      "orders": 0,
      "revenueMinor": 0
    }
  ]
}

Schema

daysnumberrequired

visitsnumberrequired

signupsnumberrequired

totalsobject[]required

Show child parameters

currencystringrequired

ordersnumberrequired

revenueMinornumberrequired

revenuePerVisitMinornumberrequired

dailyobject[]required

Show child parameters

daystringrequired

currencystringrequired

ordersnumberrequired

revenueMinornumberrequired

4XX Default Response

Same as 4XX · GET /v1/analytics/dashboards/{id}/run

5XX Default Response

Same as 4XX · GET /v1/analytics/dashboards/{id}/run

GEThttps://hermeticor.com/v1/geo-ips

Truncated addresses seen on opens and clicks, with country

Parameters

limitintegerquery

= 100

countrystringquery

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "ip": "string",
      "country": "string",
      "events": 0,
      "people": 0,
      "lastSeenAt": "2024-01-01T00:00:00Z"
    }
  ]
}

Schema

itemsItemsItem184[]required

Show child parameters

ipstringrequired

countrystringrequired

eventsnumberrequired

peoplenumberrequired

lastSeenAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/analytics/dashboards/{id}/run

5XX Default Response

Same as 4XX · GET /v1/analytics/dashboards/{id}/run

Next part

Updated Nov 8, 2026

Was this page helpful?