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>

POSThttps://hermeticor.com/v1/analytics/dashboards/owners/batch/update

Reassign dashboards to another member (null = unassigned)

Request body

application/json

idsstring[]required

ownerIdstringrequired

{
  "ids": [
    "string"
  ],
  "ownerId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/analytics/dashboards/owners/batch/update" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"],"ownerId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "count": 0
}

Schema

countintegerrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · POST /v1/analytics/dashboards/owners/batch/update

PUThttps://hermeticor.com/v1/analytics/dashboards/{id}/widgets/{reportId}

Add a report widget, or replace the one already showing it

Parameters

idstringpathrequired

reportIdstringpathrequired

Request body

application/json

titlestring

sizestring

half | full = half

{
  "title": "string",
  "size": "half"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/analytics/dashboards/{id}/widgets/{reportId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"string","size":"half"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "name": "string",
  "widgets": [
    {
      "id": "string",
      "reportId": "string",
      "title": "string",
      "size": "half"
    }
  ],
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "ownerId": null,
  "visibility": "shared"
}

Schema

idstringrequired

namestringrequired

widgetsWidgetsItem[]required

Show child parameters

idstringrequired

reportIdstringrequired

titlestring

sizestringrequired

half | full = half

createdAtstringrequired

updatedAtstringrequired

ownerIdstringrequired

= null

visibilitystringrequired

shared | private = shared

4XX Default Response

Same as 4XX · POST /v1/analytics/dashboards/owners/batch/update

5XX Default Response

Same as 4XX · POST /v1/analytics/dashboards/owners/batch/update

DELETEhttps://hermeticor.com/v1/analytics/dashboards/{id}/widgets/{reportId}

Parameters

idstringpathrequired

reportIdstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/analytics/dashboards/{id}/widgets/{reportId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PUT /v1/analytics/dashboards/{id}/widgets/{reportId}

4XX Default Response

Same as 4XX · POST /v1/analytics/dashboards/owners/batch/update

5XX Default Response

Same as 4XX · POST /v1/analytics/dashboards/owners/batch/update

GEThttps://hermeticor.com/v1/analytics/dashboards/{id}/export

Every widget as one CSV

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "filename": "string",
  "csv": "string"
}

Schema

filenamestringrequired

csvstringrequired

4XX Default Response

Same as 4XX · POST /v1/analytics/dashboards/owners/batch/update

5XX Default Response

Same as 4XX · POST /v1/analytics/dashboards/owners/batch/update

GEThttps://hermeticor.com/v1/analytics/dashboards/{id}/definition/export

The dashboard and its reports as portable JSON (no schedules, recipients or sharing)

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "version": 1,
  "dashboard": {
    "name": "string",
    "widgets": [
      {
        "report": 0,
        "title": "string",
        "size": "half"
      }
    ]
  },
  "reports": [
    {
      "name": "string",
      "query": {
        "kind": "messages",
        "from": "string",
        "to": "string",
        "groupBy": "day",
        "sourceKind": "string",
        "sourceId": "string",
        "channel": "email",
        "includeMachineOpens": true
      },
      "rollingDays": null
    }
  ]
}

Schema

versionnumberrequired

1

dashboardobjectrequired

Show child parameters

namestringrequired

widgetsobject[]required

Show child parameters

reportintegerrequired

titlestring

sizestringrequired

half | full = half

reportsobject[]required

Show child parameters

namestringrequired

rollingDaysintegerrequired

= null

4XX Default Response

Same as 4XX · POST /v1/analytics/dashboards/owners/batch/update

5XX Default Response

Same as 4XX · POST /v1/analytics/dashboards/owners/batch/update

POSThttps://hermeticor.com/v1/analytics/dashboards/import

Create a dashboard and its reports from an exported definition

Request body

application/json

versionnumberrequired

1

dashboardobjectrequired

Show child parameters

namestringrequired

widgetsobject[]required

Show child parameters

reportintegerrequired

titlestring

sizestring

half | full = half

reportsobject[]required

Show child parameters

namestringrequired

rollingDaysinteger

= null

{
  "version": 1,
  "dashboard": {
    "name": "string",
    "widgets": [
      {
        "report": 0,
        "title": "string",
        "size": "half"
      }
    ]
  },
  "reports": [
    {
      "name": "string",
      "query": {
        "kind": "messages",
        "from": "string",
        "to": "string",
        "groupBy": "day",
        "sourceKind": "string",
        "sourceId": "string",
        "channel": "email",
        "includeMachineOpens": true
      },
      "rollingDays": null
    }
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/analytics/dashboards/import" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"version":1,"dashboard":{"name":"string","widgets":[{"report":0,"title":"string","size":"half"}]},"reports":[{"name":"string","query":{"kind":"messages","from":"string","to":"string","groupBy":"day","sourceKind":"string","sourceId":"string","channel":"email","includeMachineOpens":true},"rollingDays":null}]}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Same as 200 · PUT /v1/analytics/dashboards/{id}/widgets/{reportId}

4XX Default Response

Same as 4XX · POST /v1/analytics/dashboards/owners/batch/update

5XX Default Response

Same as 4XX · POST /v1/analytics/dashboards/owners/batch/update

GEThttps://hermeticor.com/v1/analytics/dashboards/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PUT /v1/analytics/dashboards/{id}/widgets/{reportId}

4XX Default Response

Same as 4XX · POST /v1/analytics/dashboards/owners/batch/update

5XX Default Response

Same as 4XX · POST /v1/analytics/dashboards/owners/batch/update

DELETEhttps://hermeticor.com/v1/analytics/dashboards/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · POST /v1/analytics/dashboards/owners/batch/update

5XX Default Response

Same as 4XX · POST /v1/analytics/dashboards/owners/batch/update

PATCHhttps://hermeticor.com/v1/analytics/dashboards/{id}

Parameters

idstringpathrequired

Request body

application/json

namestring

widgetsWidgetsItem2[]

Show child parameters

reportIdstringrequired

titlestring

sizestring

half | full = half

{
  "name": "string",
  "widgets": [
    {
      "reportId": "string",
      "title": "string",
      "size": "half"
    }
  ]
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/analytics/dashboards/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","widgets":[{"reportId":"string","title":"string","size":"half"}]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PUT /v1/analytics/dashboards/{id}/widgets/{reportId}

4XX Default Response

Same as 4XX · POST /v1/analytics/dashboards/owners/batch/update

5XX Default Response

Same as 4XX · POST /v1/analytics/dashboards/owners/batch/update

POSThttps://hermeticor.com/v1/analytics/dashboards/{id}/clone

Copy a dashboard with its widgets

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Same as 200 · PUT /v1/analytics/dashboards/{id}/widgets/{reportId}

4XX Default Response

Same as 4XX · POST /v1/analytics/dashboards/owners/batch/update

5XX Default Response

Same as 4XX · POST /v1/analytics/dashboards/owners/batch/update

Next part

Updated Nov 8, 2026

Was this page helpful?