Reports
- GET/reports/time
- GET/reports/tickets
- GET/reports/tickets-by-client
- GET/reports/time-by-tech
- GET/reports/tech-performance
- GET/reports/technician-performance
- GET/reports/service-desk
- GET/reports/csat
- GET/reports/rmm-health
- GET/reports/unbilled-tickets
- GET/reports/expiring
- GET/reports/overview
Time logged grouped by client
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| period | query | string (week | month | all) | |
| mine | query | integer (0 | 1) |
Example request
curl "https://YOUR-HOST/api/v1/reports/time" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/reports/time",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/reports/time", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/reports/time");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Report payload (shape varies by report; always a JSON object)
Example response
{}
Ticket volume by month for a year
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| year | query | integer |
Example request
curl "https://YOUR-HOST/api/v1/reports/tickets" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/reports/tickets",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/reports/tickets", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/reports/tickets");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Report payload (shape varies by report; always a JSON object)
Example response
{}
Ticket counts by client
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| year | query | integer | |
| month | query | integer |
Example request
curl "https://YOUR-HOST/api/v1/reports/tickets-by-client" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/reports/tickets-by-client",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/reports/tickets-by-client", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/reports/tickets-by-client");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Report payload (shape varies by report; always a JSON object)
Example response
{}
Time logged grouped by technician
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| year | query | integer |
Example request
curl "https://YOUR-HOST/api/v1/reports/time-by-tech" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/reports/time-by-tech",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/reports/time-by-tech", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/reports/time-by-tech");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Report payload (shape varies by report; always a JSON object)
Example response
{}
Technician performance summary
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| year | query | integer |
Example request
curl "https://YOUR-HOST/api/v1/reports/tech-performance" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/reports/tech-performance",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/reports/tech-performance", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/reports/tech-performance");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Report payload (shape varies by report; always a JSON object)
Example response
{}
Detailed technician performance report
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| year | query | integer |
Example request
curl "https://YOUR-HOST/api/v1/reports/technician-performance" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/reports/technician-performance",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/reports/technician-performance", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/reports/technician-performance");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Report payload (shape varies by report; always a JSON object)
Example response
{}
Service-desk report
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| year | query | integer |
Example request
curl "https://YOUR-HOST/api/v1/reports/service-desk" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/reports/service-desk",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/reports/service-desk", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/reports/service-desk");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Report payload (shape varies by report; always a JSON object)
Example response
{}
Customer satisfaction (CSAT) report - 1-5 star ratings, distribution, trend, per-technician/per-client breakdowns, raw feedback feed
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| year | query | integer |
Example request
curl "https://YOUR-HOST/api/v1/reports/csat" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/reports/csat",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/reports/csat", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/reports/csat");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Report payload (shape varies by report; always a JSON object)
Example response
{}
RMM fleet health report
Example request
curl "https://YOUR-HOST/api/v1/reports/rmm-health" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/reports/rmm-health",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/reports/rmm-health", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/reports/rmm-health");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Report payload (shape varies by report; always a JSON object)
Example response
{}
Clients with unbilled billable closed tickets
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| year | query | integer |
Example request
curl "https://YOUR-HOST/api/v1/reports/unbilled-tickets" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/reports/unbilled-tickets",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/reports/unbilled-tickets", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/reports/unbilled-tickets");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Report payload (shape varies by report; always a JSON object)
Example response
{}
Domains or certificates expiring within N days
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| type | query | string (domains | certificates) | |
| days | query | integer |
Example request
curl "https://YOUR-HOST/api/v1/reports/expiring" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/reports/expiring",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/reports/expiring", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/reports/expiring");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Report payload (shape varies by report; always a JSON object)
Example response
{}
400Bad request
| Field | Type | Description |
|---|---|---|
| error | string |
Open-ticket breakdown by priority/status/category plus avg resolution
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| year | query | integer |
Example request
curl "https://YOUR-HOST/api/v1/reports/overview" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/reports/overview",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/reports/overview", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/reports/overview");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Report payload (shape varies by report; always a JSON object)
Example response
{}