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

One conversion with the touches credited for it, the event that triggered it and the activity around it

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "conversion": {
    "id": "string",
    "profileId": "string",
    "ref": "string",
    "eventId": "string",
    "goalKey": "string",
    "attributedKind": "string",
    "attributedId": "string",
    "jobId": "string",
    "channel": "string",
    "variantKey": "string",
    "stepKey": "string",
    "model": "string",
    "windowHours": 0,
    "valueMinor": 0,
    "currency": "string",
    "touchAt": "2024-01-01T00:00:00Z",
    "at": "2024-01-01T00:00:00Z"
  },
  "attributions": [
    {
      "id": "string",
      "profileId": "string",
      "ref": "string",
      "eventId": "string",
      "goalKey": "string",
      "attributedKind": "string",
      "attributedId": "string",
      "jobId": "string",
      "channel": "string",
      "variantKey": "string",
      "stepKey": "string",
      "model": "string",
      "windowHours": 0,
      "valueMinor": 0,
      "currency": "string",
      "touchAt": "2024-01-01T00:00:00Z",
      "at": "2024-01-01T00:00:00Z"
    }
  ],
  "event": null,
  "activities": []
}

Schema

conversionobjectrequired

Show child parameters

idstringrequired

profileIdstringrequired

refstringrequired

eventIdstringrequired

goalKeystringrequired

attributedKindstringrequired

attributedIdstringrequired

jobIdstringrequired

channelstringrequired

variantKeystringrequired

stepKeystringrequired

modelstringrequired

windowHoursintegerrequired

valueMinorintegerrequired

currencystringrequired

touchAtstringrequired

atstringrequired

attributionsItemsItem87[]required

Show child parameters

idstringrequired

profileIdstringrequired

refstringrequired

eventIdstringrequired

goalKeystringrequired

attributedKindstringrequired

attributedIdstringrequired

jobIdstringrequired

channelstringrequired

variantKeystringrequired

stepKeystringrequired

modelstringrequired

windowHoursintegerrequired

valueMinorintegerrequired

currencystringrequired

touchAtstringrequired

atstringrequired

eventobjectrequired

= null

Show child parameters

idstringrequired

namestringrequired

occurredAtstringrequired

valueMinorintegerrequired

currencystringrequired

propertiesobjectrequired

activitiesobject[]required

= []

Show child parameters

idstringrequired

kindstringrequired

summarystringrequired

atstringrequired

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

GEThttps://hermeticor.com/v1/analytics/conversion-folders

Conversions grouped by folder, with each conversion's count and value in the range

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "folder": "string",
      "conversions": 0,
      "valueMinor": 0,
      "labels": [
        {
          "label": "string",
          "event": "string",
          "conversions": 0,
          "valueMinor": 0
        }
      ]
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

folderstringrequired

conversionsintegerrequired

valueMinorintegerrequired

labelsobject[]required

Show child parameters

labelstringrequired

eventstringrequired

conversionsintegerrequired

valueMinorintegerrequired

nextCursorstringrequired

4XX Default Response

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

5XX Default Response

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

GEThttps://hermeticor.com/v1/analytics/conversion-labels

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "main": "string",
  "items": [
    {
      "label": "string",
      "event": "string",
      "valueProperty": "string",
      "targetMinor": 0,
      "folder": "string"
    }
  ]
}

Schema

mainstringrequired

itemsConversionsItem[]required

Show child parameters

labelstringrequired

eventstringrequired

valuePropertystring

targetMinorinteger

folderstring

4XX Default Response

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

5XX Default Response

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

POSThttps://hermeticor.com/v1/analytics/conversion-labels

Request body

application/json

labelstringrequired

eventstringrequired

valuePropertystring

targetMinorinteger

folderstring

{
  "label": "string",
  "event": "string",
  "valueProperty": "string",
  "targetMinor": 0,
  "folder": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/analytics/conversion-labels" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"label":"string","event":"string","valueProperty":"string","targetMinor":0,"folder":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "label": "string",
  "event": "string",
  "valueProperty": "string",
  "targetMinor": 0,
  "folder": "string"
}

Schema

labelstringrequired

eventstringrequired

valuePropertystring

targetMinorinteger

folderstring

4XX Default Response

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

5XX Default Response

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

POSThttps://hermeticor.com/v1/analytics/conversion-labels/bulk-create

Request body

application/json

itemsConversionsItem2[]required

Show child parameters

labelstringrequired

eventstringrequired

valuePropertystring

targetMinorinteger

folderstring

{
  "items": [
    {
      "label": "string",
      "event": "string",
      "valueProperty": "string",
      "targetMinor": 0,
      "folder": "string"
    }
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/analytics/conversion-labels/bulk-create" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"items":[{"label":"string","event":"string","valueProperty":"string","targetMinor":0,"folder":"string"}]}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Same as 200 · GET /v1/analytics/conversion-labels

4XX Default Response

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

5XX Default Response

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

POSThttps://hermeticor.com/v1/analytics/conversion-labels/bulk-delete

Request body

application/json

labelsstring[]required

{
  "labels": [
    "string"
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/analytics/conversion-labels/bulk-delete" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"labels":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "deleted": 0
}

Schema

deletedintegerrequired

4XX Default Response

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

5XX Default Response

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

GEThttps://hermeticor.com/v1/analytics/conversion-labels/{label}

Parameters

labelstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/analytics/conversion-labels/{label}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/analytics/conversion-labels

4XX Default Response

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

5XX Default Response

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

PUThttps://hermeticor.com/v1/analytics/conversion-labels/{label}

Parameters

labelstringpathrequired

Request body

application/json

eventstringrequired

valuePropertystring

targetMinorinteger

folderstring

{
  "event": "string",
  "valueProperty": "string",
  "targetMinor": 0,
  "folder": "string"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/analytics/conversion-labels/{label}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"event":"string","valueProperty":"string","targetMinor":0,"folder":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/analytics/conversion-labels

4XX Default Response

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

5XX Default Response

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

Next part

Updated Nov 8, 2026

Was this page helpful?