HaloPSA Data Stream Parameters

The HaloPSA plugin provides configurable data streams to fetch build and ticket, asset client and report data.

Each configurable data stream exposes a set of parameters that lets you filter the data you retrieve. The following information describes the available configurable data streams and their parameters in detail.

Assets (by Client)

Returns the assets belonging to one HaloPSA client, narrowed by asset status.

Parameter
Description
Asset status
Select an asset status to to filter by.

Client Details

Returns the full detail held against a single HaloPSA client, identified by client ID.

Parameter
Description
Client ID
Enter a client ID to return data for.

Clients

Returns HaloPSA clients, narrowed by whether they are active.

Parameter
Description
Client status
Select a status to filter clients by. Choose from:
  • Active clients: Returns only active clients.
  • Inactive clients: Returns only inactive clients.
  • All clients: Returns both active and inactive clients.

Invoices

Returns invoices across every client, narrowed by invoice status.

Parameter
Description
Invoice status
Select an invoice status to filter results by. Choose from:
  • All
  • Unpaid
  • Paid
  • Overdue

Invoices (by Client)

Returns the invoices for a single client, with the same status filter.

Parameter
Description
Invoice status
Select an invoice status to filter results by. Choose from:
  • All
  • Unpaid
  • Paid
  • Overdue

Quotes

Returns quotations across every client, narrowed by quote status.

Parameter
Description
Status
Select a quote status to filter results by.

Quotes (by Client)

Returns the quotations for a single client, with the same status filter.

Parameter
Description
Status
Select a quote status to filter results by.

Report Data

Returns the data behind a report already defined in HaloPSA, so a dashboard reuses reporting your team has built rather than rebuilding it.

Parameter
Description
Report
Select the report from the drop down list.
Report parameters
Optionally, enter additional parameters to filter by.

Ticket Lists

Returns the tickets in a HaloPSA list. The lists come from the HaloPSA console, so the tile shows the same queue your agents work from.

Parameter
Description
List
Select a list to return tickets for. These are configured in the HaloPSA console at Configuration > Tickets > Views > Lists.

Tickets

On the Timeframe tab you can choose which property the timeframe applies to (Created, Updated, Closed).

Parameter
Description
Clients
Select one or more clients from the dropdown list. Use the search to filter the dropdown, or click Browse to use the tile editor object selector.
Agents
Select one or more agents from the dropdown list. Use the search to filter the dropdown, or click Browse to use the tile editor object selector.
Teams
Select one or more teams from the dropdown list. Use the search to filter the dropdown, or click Browse to use the tile editor object selector.
Status
Select one or more ticket statuses to filter tickets. All Open returns all tickets whose status is considered Open in HaloPSA's configuration, regardless of the specific status name. Selecting this option ignores individual status selections.
Priority
Select one priority to filter tickets.
Type
Select one or more type to filter tickets.
Result type
  • List: All matching results are returned. This is the default option.
    You can then specify only the Columns you need, to speed up the query.
  • Count: Returns a simple count based on the number of items matching the query.
Return specific columns

By default, a standard set of columns are returned.
Here you can choose which columns are returned. If fewer columns are selected then the data will load faster. You can also specify additional columns.

Was this article helpful?

Have more questions or facing an issue?
Submit a ticket