metrics

Embed

<a href="https://hermeticor.com/docs/ref-metrics"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/ac1ea4df-e7e8-493d-a603-9a8b92226d65/social-card.svg?v=3e7ae33eec8b" alt="metrics" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/events

Workspace-wide event list: filter by name, profile, time range, properties, journey or broadcast; sort by datetime; include=metric,profile

Parameters

limitintegerquery

= 50

cursorstringquery

namestringquery

profileIdstringquery

fromstringquery

tostringquery

filterstringquery

sortstringquery

datetime | -datetime

includestringquery

journeyIdstringquery

broadcastIdstringquery

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "profileId": "string",
      "anonymousId": "string",
      "occurredAt": "2024-01-01T00:00:00Z",
      "source": "browser",
      "properties": {},
      "value": 0,
      "currency": "string",
      "metric": {
        "name": "string",
        "category": "string",
        "goal": true
      },
      "profile": {
        "id": "string",
        "email": "string",
        "firstName": "string",
        "lastName": "string"
      }
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem25[]required

Show child parameters

idstringrequired

namestringrequired

profileIdstringrequired

anonymousIdstringrequired

occurredAtstringrequired

sourcestringrequired

browser | server | integration | system

propertiesobjectrequired

valueintegerrequired

currencystringrequired

metricobject

Show child parameters

namestringrequired

categorystringrequired

goalbooleanrequired

profileobject

Show child parameters

idstringrequired

emailstringrequired

firstNamestringrequired

lastNamestringrequired

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/events

GEThttps://hermeticor.com/v1/events/export

The same filters as GET /v1/events, as CSV text (first 50,000 events); POST /v1/events/export-jobs exports every match as a file

Parameters

namestringquery

profileIdstringquery

fromstringquery

tostringquery

filterstringquery

sortstringquery

datetime | -datetime

journeyIdstringquery

broadcastIdstringquery

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "filename": "string",
  "csv": "string",
  "count": 0,
  "truncated": true
}

Schema

filenamestringrequired

csvstringrequired

countintegerrequired

truncatedbooleanrequired

4XX Default Response

Same as 4XX · GET /v1/events

5XX Default Response

Same as 4XX · GET /v1/events

POSThttps://hermeticor.com/v1/events/export-jobs

Every event matching the GET /v1/events filters as a CSV file, prepared in the background (poll GET /v1/exports/:id for the download link)

Request body

application/json

namestring

profileIdstring

fromstring

tostring

filterstring

sortstring

datetime | -datetime

journeyIdstring

broadcastIdstring

{
  "name": "string",
  "profileId": "string",
  "from": "2024-01-01T00:00:00Z",
  "to": "2024-01-01T00:00:00Z",
  "filter": "string",
  "sort": "datetime",
  "journeyId": "string",
  "broadcastId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/events/export-jobs" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","profileId":"string","from":"2024-01-01T00:00:00Z","to":"2024-01-01T00:00:00Z","filter":"string","sort":"datetime","journeyId":"string","broadcastId":"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/events

5XX Default Response

Same as 4XX · GET /v1/events

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "name": "string",
  "profileId": "string",
  "anonymousId": "string",
  "occurredAt": "2024-01-01T00:00:00Z",
  "source": "browser",
  "properties": {},
  "value": 0,
  "currency": "string",
  "metric": {
    "name": "string",
    "category": "string",
    "goal": true
  },
  "profile": {
    "id": "string",
    "email": "string",
    "firstName": "string",
    "lastName": "string"
  }
}

Schema

idstringrequired

namestringrequired

profileIdstringrequired

anonymousIdstringrequired

occurredAtstringrequired

sourcestringrequired

browser | server | integration | system

propertiesobjectrequired

valueintegerrequired

currencystringrequired

metricobject

Show child parameters

namestringrequired

categorystringrequired

goalbooleanrequired

profileobject

Show child parameters

idstringrequired

emailstringrequired

firstNamestringrequired

lastNamestringrequired

4XX Default Response

Same as 4XX · GET /v1/events

5XX Default Response

Same as 4XX · GET /v1/events

GEThttps://hermeticor.com/v1/metrics

Metrics: observed events plus custom metrics, with counts and last-seen

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "name": "string",
      "kind": "event",
      "customMetricId": "string",
      "category": "standard",
      "goal": true,
      "eventCount": 0,
      "lastEventAt": "2024-01-01T00:00:00Z",
      "firstSeenAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

namestringrequired

kindstringrequired

event | custom

customMetricIdstringrequired

categorystringrequired

standard | custom

goalbooleanrequired

eventCountintegerrequired

lastEventAtstringrequired

firstSeenAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/events

5XX Default Response

Same as 4XX · GET /v1/events

GEThttps://hermeticor.com/v1/metrics/{name}

Metric detail with observed property keys and types (name, custom metric id or mapped:<role>)

Parameters

namestringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "name": "string",
  "kind": "event",
  "customMetricId": "string",
  "category": "standard",
  "goal": true,
  "eventCount": 0,
  "lastEventAt": "2024-01-01T00:00:00Z",
  "firstSeenAt": "2024-01-01T00:00:00Z",
  "schema": {},
  "properties": [
    {
      "key": "string",
      "types": [
        "string"
      ],
      "seen": 0
    }
  ]
}

Schema

namestringrequired

kindstringrequired

event | custom

customMetricIdstringrequired

categorystringrequired

standard | custom

goalbooleanrequired

eventCountintegerrequired

lastEventAtstringrequired

firstSeenAtstringrequired

schemaobjectrequired

propertiesobject[]required

Show child parameters

keystringrequired

typesstring[]required

seenintegerrequired

4XX Default Response

Same as 4XX · GET /v1/events

5XX Default Response

Same as 4XX · GET /v1/events

Next part

Updated Nov 8, 2026

Was this page helpful?