Reporting & Views Endpoints (cont.)

Reporting & Views (continued)

ViewListGroup (continued)

GET /ViewListGroup/{id}

Summary: Get one ViewListGroup

Returns a single ViewListGroup instance. Requires authentication.

Parameter	Type	Required	Description
id	integer	Yes (path)	The group ID
includedetails	boolean	No	Include full detail fields

---

DELETE /ViewListGroup/{id}

Delete a ViewListGroup configuration by ID.

Parameter	Type	Required	Description
id	integer	Yes (path)	The group ID

---

ViewLists

Saved ticket list view configurations combining column profiles, filter profiles, and grouping.

GET /ViewLists

Summary: List of ViewLists

Returns multiple ViewLists records. Requires authentication.

Parameter	Type	Description
connectedinstance_id	integer	Filter by connected HaloPSA instance
domain	string	Filter by domain
globalonly	boolean	Return only global views
istree	boolean	Return as tree structure
showall	boolean	Show all views regardless of ownership
showallforteam	integer	Show all views for the specified team ID
showallfortech	integer	Show all views for the specified technician ID
showcounts	boolean	Include ticket counts for each view
ticketarea_id	integer	Filter by ticket area
type	string	Filter by view type

---

POST /ViewLists

Create or update ViewLists configurations.

Request Body: Array of ViewLists objects.

ViewLists Schema:

Field	Type	Description
id	integer	View ID
guid	string (uuid)	Unique identifier
intent	string	Intent/purpose label
name	string	View name
use	string	Use context
agent_id	integer	Owning agent ID
team_id	integer	Owning team ID
type	integer	View type
type_name	string	Human-readable type name
sequence	integer	Display order
showcounts	boolean	Show ticket counts
column_profile_id	integer	Associated ViewColumns profile ID
column_profile_guid	string (uuid)	Column profile GUID
filter_profile_id	integer	Associated ViewFilter profile ID
filter_profile_guid	string (uuid)	Filter profile GUID
lock_view_type	integer	Locked view type setting
connectedinstance_id	integer	Connected HaloPSA instance ID
connectedinstance_list_id	integer	List ID on connected instance
show_in_team_tree	boolean	Show in team navigation tree
show_in_team_tree_team_id	integer	Team to show in team tree
default_kanban_view	integer	Default Kanban view setting
ticket_count	integer	Current ticket count (read-only)
filters	array (ViewFilterDetails)	Inline filter criteria
group	integer	Group ID
access_control	array (AccessControl)	Access control rules
access_control_level	integer	Access control level
show_change_windows_calendar	boolean	Show change windows on calendar
use_criteria_groups	boolean	Use grouped filter criteria
criteria_groups	array (CriteriaGroup)	Grouped filter criteria

---

GET /ViewLists/{id}

Summary: Get one ViewLists

Returns a single ViewLists instance. Requires authentication.

Parameter	Type	Required	Description
id	integer	Yes (path)	The view ID
domain	string	No	Filter by domain
includedetails	boolean	No	Include full detail fields
showcounts	boolean	No	Include ticket counts

---

DELETE /ViewLists/{id}

Delete a ViewLists configuration by ID.

Parameter	Type	Required	Description
id	integer	Yes (path)	The view ID

---

DashboardLinks

Dashboard definitions including widgets, layouts, access controls, and publishing settings.

GET /DashboardLinks

Summary: List of DashboardLinks

Returns multiple DashboardLinks records. Requires authentication.

Parameter	Type	Description
access_control_level	integer	Filter by access control level
count	integer	Number of records to return
in_app	boolean	Filter to in-app dashboards only
order–order5	string	Sort fields (up to 5)
orderdesc–orderdesc5	boolean	Sort descending flags
page_no	integer	Page number for pagination
page_size	integer	Page size for pagination
pageinate	boolean	Enable pagination
showall	boolean	Show all dashboards regardless of ownership
userid	integer	Filter by owning user ID

Response: 200 OK — Array of DashboardLinks objects.

---

POST /DashboardLinks

Create a new dashboard.

Request Body: Array of DashboardLinks objects.

Response: 201 Created — The created DashboardLinks object.

DashboardLinks Schema:

Field	Type	Description
id	integer	Dashboard ID
guid	string (uuid)	Unique identifier
intent	string	Intent/purpose label
name	string	Dashboard name
use	integer	Use context type
link	string	External URL (if applicable)
iframe	boolean	Display in iframe
newtab	boolean	Open in new tab
in_app	boolean	Available as in-app dashboard
admin_only	boolean	Restrict to admins only
org_id	integer	Owning organization ID
department_id	integer	Owning department ID
team_id	integer	Owning team ID
agent_id	integer	Owning agent ID
display_type	string	Display type identifier
restriction_type	string	Access restriction type
layouts	string	Widget layout configuration (JSON)
widgets	array (Widget)	Dashboard widget definitions
access_control	array (AccessControl)	Access control rules
access_control_level	integer	Access control level
report_access_token	string	Token for report access
reportingperiod	integer	Default reporting period
reportingperiodstartdate	string (date-time)	Reporting period start date
reportingperiodenddate	string (date-time)	Reporting period end date
reportingperiodvisibility	integer	Visibility setting for reporting period controls
filters	array (DashboardFilter)	Dashboard-level filters
user_access	array (DashboardRestriction)	User-level access restrictions
is_published	boolean	Whether the dashboard is publicly published
published_id	string	Public identifier for the published dashboard
allow_anonymous	boolean	Allow anonymous access to published dashboard
rowheight	integer	Row height in pixels
manually_load_dashboards	boolean	Require manual load trigger
dashboard_theme_override	integer	Theme override setting
list_item_height	integer	Height for list items
library_id	integer	Dashboard library ID
icon	string	Icon identifier
tab_group_id	integer	Tab group ID
tab_group_name	string	Tab group name

---

GET /DashboardLinks/{id}

Summary: Get one DashboardLinks

Returns a single DashboardLinks instance. Requires authentication.

Parameter	Type	Required	Description
id	integer	Yes (path)	The dashboard ID
getreporttoken	boolean	No	Return a report access token
includedetails	boolean	No	Include full detail fields
showall	boolean	No	Show regardless of ownership
userid	integer	No	Filter by user ID

Response: 200 OK — DashboardLinks object.

---

DELETE /DashboardLinks/{id}

Delete a dashboard by ID.

Parameter	Type	Required	Description
id	integer	Yes (path)	The dashboard ID

---

GET /DashboardLinks/FilterValues

Retrieve available filter values for dashboard filtering.

No query parameters.

---

DashboardLinksRepository

Read-only repository endpoints for DashboardLinks, typically used for public/shared access scenarios.

GET /DashboardLinksRepository

Summary: List of DashboardLinks

Returns multiple DashboardLinks records. Requires authentication.

Parameter	Type	Description
access_control_level	integer	Filter by access control level
count	integer	Number of records to return
in_app	boolean	Filter to in-app dashboards only
order–order5	string	Sort fields (up to 5)
orderdesc–orderdesc5	boolean	Sort descending flags
page_no	integer	Page number for pagination
page_size	integer	Page size for pagination
pageinate	boolean	Enable pagination
showall	boolean	Show all dashboards
userid	integer	Filter by owning user ID

---

GET /DashboardLinksRepository/{id}

Summary: Get one DashboardLinks

Returns a single DashboardLinks instance via the repository endpoint. Requires authentication.

Parameter	Type	Required	Description
id	integer	Yes (path)	The dashboard ID
getreporttoken	boolean	No	Return a report access token
includedetails	boolean	No	Include full detail fields
showall	boolean	No	Show regardless of ownership
userid	integer	No	Filter by user ID

---

HistoricalTicketVolumes

Historical data tracking ticket volume over time by source and type.

GET /HistoricalTicketVolumes

Retrieve all historical ticket volume records.

No query parameters.

---

POST /HistoricalTicketVolumes

Create historical ticket volume records.

Request Body: Array of HistoricalTicketVolumes objects.

HistoricalTicketVolumes Schema:

Field	Type	Description
id	integer	Record ID
timestamp	string (date-time)	When the volume was recorded
source	integer	Ticket source identifier
tickettype	integer	Ticket type identifier
volumelogged	integer	Number of tickets logged

---

GET /HistoricalTicketVolumes/{id}

Retrieve a single historical ticket volume record by ID.

Parameter	Type	Required	Description
id	integer	Yes (path)	The record ID

---

DELETE /HistoricalTicketVolumes/{id}

Delete a historical ticket volume record by ID.

Parameter	Type	Required	Description
id	integer	Yes (path)	The record ID