Reports

How to get reports

Request Overview

Actions	Returns	Description
POST /api/v1/reports/channels	Object	Get channels report
POST /api/v1/reports/performance	Object	Get performance report

Requests

All Channels Report

GET /api/v1/reports/channels

POST /api/v1/reports/channels HTTP/1.1
Authorization: Bearer {{token}}
Hs-Client-Id: {{hs_client_id}}
Host: api.helpspace.com
Content-Type: application/json; charset=utf-8

{
   "start": "2025-01-20",
   "end": "2025-03-05"
}

200 Response

HTTP/1.1 200 OK
Content-Type: application/json
...

{
  "labels": [
    "2025-03-01",
    "2025-03-02",
    "2025-03-03",
    "2025-03-04",
    "2025-03-05"
  ],
  "opened": [1, 0, 0, 3, 0],
  "closed": [0, 1, 0, 0, 2],
  "metrics": [
    {
      "name": "new",
      "count": 4,
      "previous_count": 4,
      "percentageChange": -100
    },
    {
      "name": "closed",
      "count": 3,
      "previous_count": 0,
      "percentageChange": 0
    },
    {
      "name": "open",
      "count": 0,
      "previous_count": 1,
      "percentageChange": -100
    },
    {
      "name": "waiting",
      "count": 0,
      "previous_count": 2,
      "percentageChange": -100
    },
    {
      "name": "escalated",
      "count": 0,
      "previous_count": 0,
      "percentageChange": 0
    }
  ],
  "channel_usage": {
    "series": [],
    "labels": [],
    "colors": [
      "#818CF8",
      "#60A5FA",
      "#A78BFA",
      "#F472B6",
      "#34D399",
      "#F87171",
      "#FBBF24",
      "#2DD4BF",
      "#22D3EE",
      "#A3E635"
    ]
  },
  "tag_usage": {
    "series": [],
    "labels": [],
    "colors": []
  },
  "top_customers": [
    {
      "ticket_count": 10,
      "contact_id": 6,
      "user_id": 6,
      "name": "Example",
      "email": "example@example.com",
      "percent": 25
    }
  ]
}

Performance Report

POST /api/v1/reports/performance

POST /api/v1/reports/performance HTTP/1.1
Authorization: Bearer {{token}}
Hs-Client-Id: {{hs_client_id}}
Host: api.helpspace.com
Content-Type: application/json; charset=utf-8

{
   "start": "2024-02-20",
   "end": "2025-03-05"
}

200 Response

HTTP/1.1 200 OK
Content-Type: application/json
...

{
  "labels": [
    "2024-02-20",
    "2024-02-21",
    "2024-02-22",
    "2024-02-23"
    ...
  ],
  "opened": [
    0,
    0,
    0,
    0,
    ...
  ],
  "closed": [
    0,
    0,
    0,
    0,
    ...
  ],
  "metrics": [
    {
      "name": "average resolve time",
      "value": {
        "days": "18",
        "hours": "9",
        "minutes": "37"
      },
      "previous_value": {
        "days": "34",
        "hours": "22",
        "minutes": "59"
      },
      "percentageChange": -47
    }
  ],
  "top_agents": [
    {
      "ticket_count": 13,
      "name": "Terry",
      "percent": 100
    }
  ]
}