metrics

Embed
Preview of the card
<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>
DELETEhttps://hermeticor.com/v1/mapped-metrics/{role}

Reset a role to its default event

Parameters

rolestringpathrequired
placed_order | viewed_product | started_checkout | added_to_cart | submitted_form

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/mapped-metrics/{role}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · DELETE /v1/mapped-metrics/{role}

POSThttps://hermeticor.com/v1/metrics/ingest

A custom sender reports an outcome for a delivery id (delivered, opened, clicked, converted, bounced, spammed, dropped, deferred, failed); it feeds the same status, suppression and reports as provider events

Request body

application/json
deliveryIdstringrequired
metricstringrequired
delivered | opened | clicked | converted | bounced | spammed | dropped | deferred | failed
bounceTypestring
hard | soft
reasonstring
eventIdstring
timestampstring
hrefstring
userAgentstring
{
  "deliveryId": "string",
  "metric": "delivered",
  "bounceType": "hard",
  "reason": "string",
  "eventId": "string",
  "timestamp": "2024-01-01T00:00:00Z",
  "href": "string",
  "userAgent": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/metrics/ingest" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"deliveryId":"string","metric":"delivered","bounceType":"hard","reason":"string","eventId":"string","timestamp":"2024-01-01T00:00:00Z","href":"string","userAgent":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · DELETE /v1/mapped-metrics/{role}

4XX Default Response

Same as 4XX · DELETE /v1/mapped-metrics/{role}

5XX Default Response

Same as 4XX · DELETE /v1/mapped-metrics/{role}

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

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page
namestringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/metrics/{name}/properties" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "metric": "string",
      "property": "string",
      "type": "string",
      "values": [
        {
          "value": "string",
          "count": 0
        }
      ]
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem148[]required
Show child parameters
idstringrequired
metricstringrequired
propertystringrequired
typestringrequired
valuesValuesItem[]
Show child parameters
valuestringrequired
countintegerrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · DELETE /v1/mapped-metrics/{role}

5XX Default Response

Same as 4XX · DELETE /v1/mapped-metrics/{role}

GEThttps://hermeticor.com/v1/metric-properties/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/metric-properties/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "id": "string",
  "metric": "string",
  "property": "string",
  "type": "string",
  "values": [
    {
      "value": "string",
      "count": 0
    }
  ]
}
Schema
idstringrequired
metricstringrequired
propertystringrequired
typestringrequired
valuesValuesItem[]
Show child parameters
valuestringrequired
countintegerrequired
4XX Default Response

Same as 4XX · DELETE /v1/mapped-metrics/{role}

5XX Default Response

Same as 4XX · DELETE /v1/mapped-metrics/{role}

Updated