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)

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

Client Details

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

Clients

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

Parameter
Description
Invoice status
Select an invoice status to filter results by. Choose from:
  • All
  • Unpaid
  • Paid
  • Overdue
Timeframe based on
Select which column to apply the tile timeframe to. This will return data for the given time period by evaluating it against that column.

Invoices (by Client)

Parameter
Description
Invoice status
Select an invoice status to filter results by. Choose from:
  • All
  • Unpaid
  • Paid
  • Overdue
Timeframe based on
Select which column to apply the tile timeframe to. This will return data for the given time period by evaluating it against that column.

Quotes

Parameter
Description
Status
Select a quote status to filter results by.
Timeframe based on
Select which column to apply the tile timeframe to. This will return data for the given time period by evaluating it against that column.

Quotes (by Client)

Parameter
Description
Status
Select a quote status to filter results by.
Timeframe based on
Select which column to apply the tile timeframe to. This will return data for the given time period by evaluating it against that column.

Report Data

Parameter
Description
Report ID
Enter the ID of a report to return data for. You can use the Report List data stream to look up report IDs.
Report parameters
Optionally, enter additional parameters to filter by.

Ticket Lists

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
Client
Select one or more clients from the drop down list. Use the search to filter the drop down, 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
Select Count to speed up the data return if you only need the count of tickets.

Was this article helpful?

Have more questions or facing an issue?
Submit a ticket