Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Remote Session Data → List Of Remote Session Data

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve data related to remote sessions. Specifically, the "List Of Remote Session Data" operation fetches a list of remote session records based on various filtering, ordering, and pagination parameters.

Typical use cases include:

  • Monitoring or auditing remote support sessions conducted by agents.
  • Extracting session data for reporting or analytics.
  • Filtering sessions by agent, client, site, or other criteria to focus on relevant records.

For example, you could use this node to get all remote sessions performed by a specific agent within a date range, ordered by session start time, and paginate through results if there are many.

Properties

Name Meaning
Agent Filter sessions by the agent's name or identifier.
Agent Id Filter sessions by the unique identifier of the agent.
Client Id Filter sessions by the client identifier associated with the session.
Count Limit the number of sessions returned.
Includelinked Optionally include linked data related to the sessions (exact meaning depends on API).
Order Primary field to order the results by (e.g., date, agent).
Order 2 Secondary ordering field.
Order 3 Tertiary ordering field.
Order 4 Fourth-level ordering field.
Order 5 Fifth-level ordering field.
Orderdesc Boolean or flag indicating descending order for primary order field.
Orderdesc 2 Descending order flag for secondary order field.
Orderdesc 3 Descending order flag for tertiary order field.
Orderdesc 4 Descending order flag for fourth order field.
Orderdesc 5 Descending order flag for fifth order field.
Page No Page number for paginated results.
Page Size Number of items per page in paginated results.
Pageinate Flag to enable or disable pagination.
Search Text search filter applied to sessions.
Site Id Filter sessions by site identifier.
Username Filter sessions by username associated with the session.

Output

The node outputs an array of JSON objects, each representing a remote session record as returned by the Halo PSA API. The exact structure depends on the API response but typically includes details such as session identifiers, agent info, client info, timestamps, and session metadata.

If the API supports binary data for sessions (e.g., recordings or attachments), the node would handle it accordingly, but based on the provided code and operation, output is JSON-only.

Dependencies

  • Requires connection to the Halo PSA API.
  • Needs credentials including base URL, tenant identifier, client ID, and client secret for authentication.
  • The node uses HTTP requests with appropriate headers to communicate with the API.
  • No additional external services beyond the Halo PSA API are required.

Troubleshooting

  • No credentials returned!
    This error occurs if the node cannot find or access the required API credentials. Ensure that valid credentials are configured in n8n before running the node.

  • Resource or Operation not found
    If the specified resource or operation does not exist, verify that the correct resource ("Remote Session Data") and operation ("List Of Remote Session Data") names are used.

  • API request errors
    Network issues, invalid parameters, or authentication failures can cause errors during the API call. Check the credentials, network connectivity, and parameter values.

  • JSON parsing errors
    If using advanced JSON parameters, ensure that any JSON strings are correctly formatted.

  • Pagination issues
    Incorrect page numbers or sizes may result in empty or incomplete data sets. Adjust pagination parameters accordingly.

Links and References

Note: The above summary is based solely on static analysis of the provided source code and property definitions.

Discussion