Reporting & Views Endpoints

Reporting & Views

---

ReportData

GET /ReportData/{publishedid}

Retrieve report data by published ID. Used for accessing publicly published reports.

Parameter	Type	Required	Description
publishedid	string	Yes (path)	The published report identifier

---

ReportRepository

GET /ReportRepository

Summary: List of AnalyzerProfile

Returns multiple AnalyzerProfile records. Requires authentication.

Parameter	Type	Description
agentrestriction	integer	Filter by agent restriction
chartonly	boolean	Return only chart-type reports
clientname	string	Filter by client name
count	integer	Number of records to return
includepublished	boolean	Include published reports
order	string	Primary sort field
order2–order5	string	Secondary sort fields
orderdesc–orderdesc5	boolean	Sort descending flags for each order field
page_no	integer	Page number for pagination
page_size	integer	Page size for pagination
pageinate	boolean	Enable pagination
reportgroup_id	integer	Filter by report group ID
search	string	Search term
type	integer	Filter by report type

---

GET /ReportRepository/{id}

Summary: Get one AnalyzerProfile

Returns a single AnalyzerProfile instance. Requires authentication.

Parameter	Type	Required	Description
id	integer	Yes (path)	The AnalyzerProfile ID
client_id	integer	No	Filter by client ID
clientname	string	No	Filter by client name
dashboard_id	integer	No	Associated dashboard ID
dashboard_published_id	string	No	Published dashboard identifier
dontloadsystemreport	boolean	No	Skip loading system report data
getcompositetoken	boolean	No	Return composite access token
includedetails	boolean	No	Include full detail fields
invoice_id	integer	No	Associated invoice ID
loadreport	boolean	No	Load the full report data
report_access_token	string	No	Access token for report
reportingperiod	integer	No	Reporting period identifier
reportingperiodenddate	string	No	End date for reporting period
reportingperiodstartdate	string	No	Start date for reporting period

---

GET /ReportRepository/ReportCategories

Summary: List of Lookup

Returns report category lookups. Requires authentication.

Parameter	Type	Description
access_control_level	integer	Filter by access control level
assettype_id	integer	Filter by asset type
client_id	integer	Filter by client
clientname	string	Filter by client name
contract_id	integer	Filter by contract
country_code_id	integer	Filter by country code
dbc_company_id	string	Filter by DBC company
domain	string	Filter by domain
exclude_nocharge	boolean	Exclude no-charge categories
exclude_nolinkedtypes	boolean	Exclude unlinked types
exclude_zero	boolean	Exclude zero-value entries
iscustomfield	boolean	Filter to custom fields only
istree	boolean	Return as tree structure
lookupid	integer	Specific lookup ID
ordervaluetype	integer	Order by value type
outcome_id	integer	Filter by outcome
showallcodes	boolean	Show all codes
ticket_id	integer	Filter by ticket
unameaprestriction	boolean	Apply username/AP restriction
use	integer	Filter by use type
use2	integer	Secondary use type filter

---

CustomQuery

GET /CustomQuery

Retrieve all custom queries.

No query parameters.

---

POST /CustomQuery

Create or run custom queries.

Request Body: Array of CustomQuery objects.

CustomQuery Schema:

Field	Type	Description
id	integer	Query ID
name	string	Query name
sql_script	string	SQL script to execute
run	boolean	Whether to execute the query
run_result	object (CustomSQLResult)	Result of the query execution
lookup_values	array (KeyPair)	Key-value pairs for lookup results
column_name	string	Target column name
top_max	integer	Maximum number of rows to return

---

GET /CustomQuery/{id}

Retrieve a single custom query by ID.

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

---

DELETE /CustomQuery/{id}

Delete a custom query by ID.

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

---

ViewColumns

Column profile configurations for ticket list views.

GET /ViewColumns

Summary: List of ViewColumns

Returns multiple ViewColumns records. Requires authentication.

Parameter	Type	Description
globalonly	boolean	Return only global column profiles
showall	boolean	Show all profiles regardless of ownership
showallforteam	integer	Show all profiles for the specified team ID
showallfortech	integer	Show all profiles for the specified technician ID
ticketarea_id	integer	Filter by ticket area
type	string	Filter by view type

---

POST /ViewColumns

Create or update ViewColumns profiles.

Request Body: Array of ViewColumns objects.

ViewColumns Schema:

Field	Type	Description
id	integer	Column profile ID
guid	string (uuid)	Unique identifier
intent	string	Intent/purpose label
name	string	Profile name
tile_html	string	HTML template for tile view
columns	array (ViewColumnsDetails)	Column definitions
card_html	string	HTML template for card view
calendar_event_title	string	Title format for calendar events
linked_dashboard_id	integer	Associated dashboard ID
use_dashboard	boolean	Whether to use linked dashboard
include_children	boolean	Include child records
access_control	array (AccessControl)	Access control rules
access_control_level	integer	Access control level
agent_id	integer	Owning agent ID
team_id	integer	Owning team ID
type	integer	View type
collapse_by_default	boolean	Collapse columns by default
type_name	string	Human-readable type name

---

GET /ViewColumns/{id}

Summary: Get one ViewColumns

Returns a single ViewColumns instance. Requires authentication.

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

---

DELETE /ViewColumns/{id}

Delete a ViewColumns profile by ID.

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

---

ViewFilter

Filter profile configurations for ticket list views.

GET /ViewFilter

Summary: List of ViewFilter

Returns multiple ViewFilter records. Requires authentication.

Parameter	Type	Description
globalonly	boolean	Return only global filter profiles
showall	boolean	Show all profiles regardless of ownership
showallforteam	integer	Show all profiles for the specified team ID
showallfortech	integer	Show all profiles for the specified technician ID
ticketarea_id	integer	Filter by ticket area
type	string	Filter by view type

---

POST /ViewFilter

Create or update ViewFilter profiles.

Request Body: Array of ViewFilter objects.

ViewFilter Schema:

Field	Type	Description
id	integer	Filter profile ID
guid	string (uuid)	Unique identifier
intent	string	Intent/purpose label
name	string	Profile name
agent_id	integer	Owning agent ID
team_id	integer	Owning team ID
type	integer	Filter type
type_name	string	Human-readable type name
sys_id	string	System identifier
show_on_portal	boolean	Whether to expose on client portal
filters	array (ViewFilterDetails)	Filter criteria definitions
access_control	array (AccessControl)	Access control rules
access_control_level	integer	Access control level

---

GET /ViewFilter/{id}

Summary: Get one ViewFilter

Returns a single ViewFilter instance. Requires authentication.

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

---

DELETE /ViewFilter/{id}

Delete a ViewFilter profile by ID.

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

---

ViewListGroup

Grouping configurations for ticket list views.

GET /ViewListGroup

Summary: List of ViewListGroup

Returns multiple ViewListGroup records. Requires authentication.

Parameter	Type	Description
type	string	Filter by group type

---

POST /ViewListGroup

Create or update ViewListGroup configurations.

Request Body: Array of ViewListGroup objects.

ViewListGroup Schema:

Field	Type	Description
id	integer	Group ID
name	string	Group name
sequence	integer	Display order
type	integer	Group type
collapsed	boolean	Whether group is collapsed by default