analytics

Embed
Preview of the card
<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>
DELETEhttps://hermeticor.com/v1/analytics/conversion-labels/{label}

Parameters

labelstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/analytics/conversion-labels/{label}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "deleted": 0
}
Schema
deletedintegerrequired
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/analytics/conversion-labels/{label}

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

Set the value target of a conversion

Parameters

labelstringpathrequired

Request body

application/json
targetMinorintegerrequired
{
  "targetMinor": 0
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/analytics/conversion-labels/{label}/target" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"targetMinor":0}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 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 · DELETE /v1/analytics/conversion-labels/{label}

5XX Default Response

Same as 4XX · DELETE /v1/analytics/conversion-labels/{label}

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

Parameters

labelstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/analytics/conversion-labels/{label}/target" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · PUT /v1/analytics/conversion-labels/{label}/target

4XX Default Response

Same as 4XX · DELETE /v1/analytics/conversion-labels/{label}

5XX Default Response

Same as 4XX · DELETE /v1/analytics/conversion-labels/{label}

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

Parameters

fromstringqueryrequired
tostringqueryrequired
labelstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/analytics/conversion-labels/{label}/metrics?from=<from>&to=<to>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "label": "string",
  "conversions": 0,
  "uniqueProfiles": 0,
  "valueMinor": 0,
  "targetMinor": 0,
  "targetProgress": 0
}
Schema
labelstringrequired
conversionsintegerrequired
uniqueProfilesintegerrequired
valueMinorintegerrequired
targetMinorintegerrequired
targetProgressnumberrequired
4XX Default Response

Same as 4XX · DELETE /v1/analytics/conversion-labels/{label}

5XX Default Response

Same as 4XX · DELETE /v1/analytics/conversion-labels/{label}

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

Parameters

fromstringqueryrequired
tostringqueryrequired
labelstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/analytics/conversion-labels/{label}/trend?from=<from>&to=<to>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "label": "string",
  "points": [
    {
      "day": "string",
      "conversions": 0,
      "valueMinor": 0
    }
  ]
}
Schema
labelstringrequired
pointsobject[]required
Show child parameters
daystringrequired
conversionsintegerrequired
valueMinorintegerrequired
4XX Default Response

Same as 4XX · DELETE /v1/analytics/conversion-labels/{label}

5XX Default Response

Same as 4XX · DELETE /v1/analytics/conversion-labels/{label}

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

Dashboard overview. Rates are null (not 0) where the connection cannot report the metric.

Parameters

fromstringqueryrequired
tostringqueryrequired
includeMachineOpensstringquery
true | false

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/analytics/overview?from=<from>&to=<to>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "sends": {
    "totals": {},
    "byDay": [
      {
        "day": "string",
        "sent": 0
      }
    ]
  },
  "availability": {},
  "deliverability": {
    "deliveryRate": 0,
    "bounceRate": 0,
    "complaintRate": 0
  },
  "engagement": {
    "openRate": 0,
    "clickRate": 0,
    "replyRate": 0
  },
  "revenue": {
    "currency": "string",
    "totalMinor": 0,
    "conversions": 0,
    "byDay": [
      {
        "day": "string",
        "revenueMinor": 0
      }
    ],
    "store": {
      "totalMinor": 0,
      "orders": 0,
      "byDay": [
        {
          "day": "string",
          "revenueMinor": 0
        }
      ]
    },
    "byChannel": [
      {
        "channel": "string",
        "revenueMinor": 0,
        "conversions": 0
      }
    ]
  },
  "topCampaigns": [
    {
      "id": "string",
      "counts": {},
      "revenueMinor": 0,
      "conversions": 0
    }
  ],
  "topFlows": [
    {
      "id": "string",
      "counts": {},
      "revenueMinor": 0,
      "conversions": 0
    }
  ],
  "listGrowth": [
    {
      "day": "string",
      "added": 0,
      "removed": 0
    }
  ],
  "unsubscribeTrend": [
    {
      "day": "string",
      "unsubscribed": 0
    }
  ]
}
Schema
sendsobjectrequired
Show child parameters
totalsobjectrequired
byDayobject[]required
Show child parameters
daystringrequired
sentintegerrequired
availabilityobjectrequired
deliverabilityobjectrequired
Show child parameters
deliveryRatenumberrequired
bounceRatenumberrequired
complaintRatenumberrequired
engagementobjectrequired
Show child parameters
openRatenumberrequired
clickRatenumberrequired
replyRatenumberrequired
revenueobjectrequired
Show child parameters
currencystringrequired
totalMinorintegerrequired
conversionsintegerrequired
byDayByDayItem[]required
Show child parameters
daystringrequired
revenueMinorintegerrequired
storeobject
Show child parameters
totalMinorintegerrequired
ordersintegerrequired
byDayByDayItem[]required
byChannelobject[]
Show child parameters
channelstringrequired
revenueMinorintegerrequired
conversionsintegerrequired
topCampaignsTopCampaignsItem[]required
Show child parameters
idstringrequired
countsobjectrequired
revenueMinorintegerrequired
conversionsintegerrequired
topFlowsTopCampaignsItem[]required
Show child parameters
idstringrequired
countsobjectrequired
revenueMinorintegerrequired
conversionsintegerrequired
listGrowthobject[]required
Show child parameters
daystringrequired
addedintegerrequired
removedintegerrequired
unsubscribeTrendobject[]required
Show child parameters
daystringrequired
unsubscribedintegerrequired
4XX Default Response

Same as 4XX · DELETE /v1/analytics/conversion-labels/{label}

5XX Default Response

Same as 4XX · DELETE /v1/analytics/conversion-labels/{label}

GEThttps://hermeticor.com/v1/analytics/segments/{id}/trend

Parameters

fromstringqueryrequired
tostringqueryrequired
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/analytics/segments/{id}/trend?from=<from>&to=<to>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "segmentId": "string",
  "points": [
    {
      "day": "string",
      "count": 0
    }
  ]
}
Schema
segmentIdstringrequired
pointsPointsItem[]required
Show child parameters
daystringrequired
countintegerrequired
4XX Default Response

Same as 4XX · DELETE /v1/analytics/conversion-labels/{label}

5XX Default Response

Same as 4XX · DELETE /v1/analytics/conversion-labels/{label}

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

Parameters

fromstringqueryrequired
tostringqueryrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/analytics/forms?from=<from>&to=<to>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "forms": [
    {
      "formId": "string",
      "name": "string",
      "views": 0,
      "submissions": 0,
      "conversionRate": 0,
      "versions": [
        {
          "versionId": "string",
          "views": 0,
          "submissions": 0,
          "conversionRate": 0
        }
      ]
    }
  ]
}
Schema
formsobject[]required
Show child parameters
formIdstringrequired
namestringrequired
viewsintegerrequired
submissionsintegerrequired
conversionRatenumberrequired
versionsobject[]required
Show child parameters
versionIdstringrequired
viewsintegerrequired
submissionsintegerrequired
conversionRatenumberrequired
4XX Default Response

Same as 4XX · DELETE /v1/analytics/conversion-labels/{label}

5XX Default Response

Same as 4XX · DELETE /v1/analytics/conversion-labels/{label}

Updated