Skip to content

reporting.md

Latest commit

 

History

History
62 lines (35 loc) · 2.29 KB

reporting.md

File metadata and controls

62 lines (35 loc) · 2.29 KB

Reporting Operations

Query the HaloPSA reporting database and run saved reports. Requires OAuth scopes that include reporting (read:reporting for queries and list; edit:reporting may be required to run some reports).

Contract Utilisation

Per-client agreement hours charged vs contract entitlement for a UTC date range. Matches halopsa-mcp halopsa_get_contract_utilisation.

Uses reporting SQL on ACTIONS.ActionChargeHours (where ActionContractID < 0) and joins /api/ClientContract for numberofunitsfree.

Parameters:

  • Start Date (UTC) / End Date (UTC) — Defaults to the current UTC calendar month
  • Client ID — Optional filter (0 = all)
  • Limit — Max rows returned (default 50)

Output: One item per client/contract with charge_hours, contracted_hours, overage_hours, over_budget, etc.

Execute SQL Query

Run a read-only SELECT (or WITH … SELECT) against the reporting database via POST /api/Report with _loadreportonly.

Parameters:

  • SQL — The query (max 8000 characters). Use TOP N to limit rows. All datetimes are UTC. Comments and semicolons are not allowed.

Output: One item per result row. If zero rows, a single item with row_count: 0 and optional raw_response.

Example:

SELECT TOP 50 faultid, summary, status FROM faults WHERE dateoccured >= '2026-01-01T00:00:00Z' ORDER BY faultid DESC

Get Many

List saved report definitions (GET /api/Report). Return All paginates through all pages; limited requests cap at 100 per API call.

Get by ID

Retrieve a report definition including SQL and parameters (GET /api/Report/{id}).

Run

Load and execute a saved report (GET /api/Report/{id}?loadreport=true) with optional Parameters JSON merged into the query string (e.g. client_id, ticket_id, reportingperiod).

Print

POST /api/Report/print with an AnalyzerProfile body array for the selected report.

Create PDF

POST /api/Report/createpdf with an AnalyzerProfile body to generate a PDF.

Bookmark

POST /api/Report/Bookmark to bookmark a saved report.

Get Published Report Data

GET /api/ReportData/{publishedId} for published report payloads.

List / Get Repository Reports

GET /api/ReportRepository and GET /api/ReportRepository/{id} for the online report repository.