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>
GEThttps://hermeticor.com/v1/campaign-folders/{id}/report

Roll-up of everything filed in a campaign folder: contacts reached (first touch, last touch, influenced), message, form and page metrics, and revenue

Parameters

fromstringqueryrequired
tostringqueryrequired
idstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "folderId": "string",
  "name": "string",
  "contacts": {
    "influenced": 0,
    "firstTouch": 0,
    "lastTouch": 0
  },
  "assets": {
    "campaigns": 0,
    "workflows": 0,
    "forms": 0,
    "pages": 0
  },
  "messages": {},
  "forms": {
    "views": 0,
    "submissions": 0
  },
  "pages": {
    "visits": 0,
    "signups": 0
  },
  "revenue": {
    "orders": 0,
    "byCurrency": [
      {
        "currency": "string",
        "minor": 0
      }
    ]
  }
}
Schema
folderIdstringrequired
namestringrequired
contactsobjectrequired
Show child parameters
influencedintegerrequired
firstTouchintegerrequired
lastTouchintegerrequired
assetsobjectrequired
Show child parameters
campaignsintegerrequired
workflowsintegerrequired
formsintegerrequired
pagesintegerrequired
messagesobjectrequired
formsobjectrequired
Show child parameters
viewsintegerrequired
submissionsintegerrequired
pagesobjectrequired
Show child parameters
visitsintegerrequired
signupsintegerrequired
revenueobjectrequired
Show child parameters
ordersintegerrequired
byCurrencyobject[]required
Show child parameters
currencystringrequired
minornumberrequired
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/campaign-folders/{id}/report

GEThttps://hermeticor.com/v1/analytics/surveys/{id}/report

Survey report: responses and answer breakdown per question, optionally for the members of one list or segment

Parameters

listIdstringquery
segmentIdstringquery
idstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "surveyId": "string",
  "title": "string",
  "scoped": true,
  "respondents": 0,
  "completed": 0,
  "views": 0,
  "completionRate": 0,
  "responseRate": 0,
  "audience": {
    "signedReaders": 0,
    "anonymous": 0,
    "anonymousWithContact": 0
  },
  "questions": [
    {
      "questionId": "string",
      "prompt": "string",
      "kind": "string",
      "answered": 0,
      "options": [
        {
          "id": "string",
          "label": "string",
          "votes": 0
        }
      ]
    }
  ]
}
Schema
surveyIdstringrequired
titlestringrequired
scopedbooleanrequired
respondentsintegerrequired
completedintegerrequired
viewsnumberrequired
completionRatenumberrequired
responseRatenumberrequired
audienceobjectrequired
Show child parameters
signedReadersintegerrequired
anonymousintegerrequired
anonymousWithContactintegerrequired
questionsobject[]required
Show child parameters
questionIdstringrequired
promptstringrequired
kindstringrequired
answeredintegerrequired
optionsOptionsItem3[]required
Show child parameters
idstringrequired
labelstringrequired
votesintegerrequired
4XX Default Response

Same as 4XX · GET /v1/campaign-folders/{id}/report

5XX Default Response

Same as 4XX · GET /v1/campaign-folders/{id}/report

GEThttps://hermeticor.com/v1/analytics/landing-pages

Landing page report: visits, unique visitors, sign-ups and conversion rate per page over a date range

Parameters

fromstringqueryrequired
tostringqueryrequired

Code samples

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

Responses

200 Default Response
Example
{
  "from": "string",
  "to": "string",
  "items": [
    {
      "pageId": "string",
      "name": "string",
      "slug": "string",
      "status": "string",
      "visits": 0,
      "uniqueVisitors": 0,
      "clicks": 0,
      "signups": 0,
      "orders": 0,
      "revenue": [
        {
          "currency": "string",
          "minor": 0
        }
      ]
    }
  ]
}
Schema
fromstringrequired
tostringrequired
itemsobject[]required
Show child parameters
pageIdstringrequired
namestringrequired
slugstringrequired
statusstringrequired
visitsintegerrequired
uniqueVisitorsintegerrequired
clicksintegerrequired
signupsintegerrequired
ordersintegerrequired
revenueobject[]required
Show child parameters
currencystringrequired
minornumberrequired
4XX Default Response

Same as 4XX · GET /v1/campaign-folders/{id}/report

5XX Default Response

Same as 4XX · GET /v1/campaign-folders/{id}/report

Updated