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/benchmarks/flows

Peer benchmarks (flows): your last 90 days against peer percentiles, falling back to a labelled static reference table

Parameters

industrystringquery

sizestringquery

regionstringquery

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "section": "overview",
  "optedIn": true,
  "days": 0,
  "currency": "string",
  "requested": {
    "industry": "string",
    "size": "string",
    "region": "string"
  },
  "metrics": [
    {
      "key": "string",
      "unit": "rate",
      "lowerIsBetter": true,
      "yours": 0,
      "source": "network",
      "peers": {
        "p10": 0,
        "p25": 0,
        "p50": 0,
        "p75": 0,
        "p90": 0,
        "mean": 0
      },
      "rank": 0,
      "status": "poor",
      "peerGroup": {
        "cohort": "string",
        "contributors": 0,
        "rolledUp": [
          "string"
        ]
      },
      "fx": {
        "currency": "string",
        "rateDate": "string"
      },
      "reference": {
        "low": 0,
        "high": 0,
        "verdict": "below"
      }
    }
  ],
  "summary": {
    "poor": 0,
    "fair": 0,
    "good": 0,
    "excellent": 0,
    "unranked": 0
  },
  "notice": "string",
  "staticDataset": {
    "version": "string",
    "note": "string"
  }
}

Schema

sectionstringrequired

overview | campaigns | flows | forms | sms

optedInbooleanrequired

daysintegerrequired

currencystringrequired

requestedobjectrequired

Show child parameters

industrystringrequired

sizestringrequired

regionstringrequired

metricsMetricsItem[]required

Show child parameters

keystringrequired

unitstringrequired

rate | money

lowerIsBetterbooleanrequired

yoursnumberrequired

sourcestringrequired

network | local_peers | static_reference

peersobjectrequired

Show child parameters

p10numberrequired

p25numberrequired

p50numberrequired

p75numberrequired

p90numberrequired

meannumberrequired

rankintegerrequired

statusstringrequired

poor | fair | good | excellent

peerGroupobjectrequired

Show child parameters

cohortstringrequired

contributorsintegerrequired

rolledUpstring[]required

fxobject

Show child parameters

currencystringrequired

rateDatestringrequired

referenceobjectrequired

Show child parameters

lownumberrequired

highnumberrequired

verdictstringrequired

below | within | above

summaryobjectrequired

Show child parameters

poorintegerrequired

fairintegerrequired

goodintegerrequired

excellentintegerrequired

unrankedintegerrequired

noticestringrequired

staticDatasetobjectrequired

Show child parameters

versionstringrequired

notestringrequired

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/benchmarks/flows

GEThttps://hermeticor.com/v1/benchmarks/forms

Peer benchmarks (forms): your last 90 days against peer percentiles, falling back to a labelled static reference table

Parameters

industrystringquery

sizestringquery

regionstringquery

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/benchmarks/flows

4XX Default Response

Same as 4XX · GET /v1/benchmarks/flows

5XX Default Response

Same as 4XX · GET /v1/benchmarks/flows

GEThttps://hermeticor.com/v1/benchmarks/sms

Peer benchmarks (sms): your last 90 days against peer percentiles, falling back to a labelled static reference table

Parameters

industrystringquery

sizestringquery

regionstringquery

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/benchmarks/flows

4XX Default Response

Same as 4XX · GET /v1/benchmarks/flows

5XX Default Response

Same as 4XX · GET /v1/benchmarks/flows

GEThttps://hermeticor.com/v1/analytics/record-sources

Report builder record sources (contacts, companies, form results, page hits, asset downloads, workflow log, point log, frequency rules) and their columns

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "source": "contacts",
      "columns": [
        "string"
      ],
      "available": true
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

sourcestringrequired

columnsstring[]required

availablebooleanrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/benchmarks/flows

5XX Default Response

Same as 4XX · GET /v1/benchmarks/flows

POSThttps://hermeticor.com/v1/analytics/records/run

Run a record-source report without saving it: pick columns, filter, order and limit

Request body

application/json

kindstringrequired

records

sourcestringrequired

fromstringrequired

tostringrequired

columnsstring[]required

filtersFiltersItem6[]

= []

Show child parameters

columnstringrequired

opstringrequired

eq | neq | contains | gt | lt | empty | not_empty

valuestring

orderByobject

Show child parameters

columnstringrequired

dirstring

asc | desc = desc

limitinteger

= 500

{
  "kind": "records",
  "source": "contacts",
  "from": "string",
  "to": "string",
  "columns": [
    "string"
  ],
  "filters": [],
  "orderBy": {
    "column": "string",
    "dir": "desc"
  },
  "limit": 500
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/analytics/records/run" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"records","source":"contacts","from":"string","to":"string","columns":["string"],"filters":[],"orderBy":{"column":"string","dir":"desc"},"limit":500}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "source": "contacts",
  "columns": [
    "string"
  ],
  "rows": [
    {}
  ],
  "truncated": true
}

Schema

sourcestringrequired

columnsstring[]required

rowsobject[]required

truncatedbooleanrequired

4XX Default Response

Same as 4XX · GET /v1/benchmarks/flows

5XX Default Response

Same as 4XX · GET /v1/benchmarks/flows

POSThttps://hermeticor.com/v1/exports/message-events

Every message event (delivered, open, click, bounce ...) with its message, as CSV (poll GET /v1/exports/:id)

Request body

application/json

fromstring

tostring

channelstring

email | sms | whatsapp

notifyEmailstring

{
  "from": "2024-01-01T00:00:00Z",
  "to": "2024-01-01T00:00:00Z",
  "channel": "email",
  "notifyEmail": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/exports/message-events" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"2024-01-01T00:00:00Z","to":"2024-01-01T00:00:00Z","channel":"email","notifyEmail":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

202 Default Response

Example

{
  "id": "string",
  "kind": "bulk",
  "op": "string",
  "status": "queued",
  "progress": {
    "total": 0,
    "processed": 0,
    "failed": 0
  },
  "error": "string",
  "downloadUrl": "string",
  "failures": [
    {
      "profileId": "string",
      "message": "string"
    }
  ],
  "createdAt": "2024-01-01T00:00:00Z",
  "finishedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

kindstringrequired

bulk | export

opstringrequired

statusstringrequired

queued | running | completed | failed

progressobjectrequired

Show child parameters

totalintegerrequired

processedintegerrequired

failedintegerrequired

errorstringrequired

downloadUrlstring

failuresFailuresItem[]

Show child parameters

profileIdstringrequired

messagestringrequired

createdAtstringrequired

finishedAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/benchmarks/flows

5XX Default Response

Same as 4XX · GET /v1/benchmarks/flows

POSThttps://hermeticor.com/v1/exports/clicks

Every human link click with its message and URL, as CSV (poll GET /v1/exports/:id)

Request body

application/json

fromstring

tostring

channelstring

email | sms | whatsapp

notifyEmailstring

{
  "from": "2024-01-01T00:00:00Z",
  "to": "2024-01-01T00:00:00Z",
  "channel": "email",
  "notifyEmail": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/exports/clicks" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"2024-01-01T00:00:00Z","to":"2024-01-01T00:00:00Z","channel":"email","notifyEmail":"string"}'

TypeScript

Python

PHP

Ruby

Java