Skip to content

API reference / RivetIT

Reports

GET /reports/time Bearer token or API key

Time logged grouped by client

Parameters

NameInTypeDescription
periodquerystring (week | month | all)
minequeryinteger (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
json
{}
GET /reports/tickets Bearer token or API key

Ticket volume by month for a year

Parameters

NameInTypeDescription
yearqueryinteger

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
json
{}
GET /reports/tickets-by-client Bearer token or API key

Ticket counts by client

Parameters

NameInTypeDescription
yearqueryinteger
monthqueryinteger

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
json
{}
GET /reports/time-by-tech Bearer token or API key

Time logged grouped by technician

Parameters

NameInTypeDescription
yearqueryinteger

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
json
{}
GET /reports/tech-performance Bearer token or API key

Technician performance summary

Parameters

NameInTypeDescription
yearqueryinteger

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
json
{}
GET /reports/technician-performance Bearer token or API key

Detailed technician performance report

Parameters

NameInTypeDescription
yearqueryinteger

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
json
{}
GET /reports/service-desk Bearer token or API key

Service-desk report

Parameters

NameInTypeDescription
yearqueryinteger

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
json
{}
GET /reports/csat Bearer token or API key

Customer satisfaction (CSAT) report - 1-5 star ratings, distribution, trend, per-technician/per-client breakdowns, raw feedback feed

Parameters

NameInTypeDescription
yearqueryinteger

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
json
{}
GET /reports/rmm-health Bearer token or API key

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
json
{}
GET /reports/unbilled-tickets Bearer token or API key

Clients with unbilled billable closed tickets

Parameters

NameInTypeDescription
yearqueryinteger

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
json
{}
GET /reports/expiring Bearer token or API key

Domains or certificates expiring within N days

Parameters

NameInTypeDescription
typequerystring (domains | certificates)
daysqueryinteger

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
json
{}

400Bad request

FieldTypeDescription
error string
GET /reports/overview Bearer token or API key

Open-ticket breakdown by priority/status/category plus avg resolution

Parameters

NameInTypeDescription
yearqueryinteger

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
json
{}