Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Report Repository → List Of Analyzer Profile

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve a list of analyzer profiles from the Report Repository resource. It is designed to fetch and filter analyzer profile data based on various query parameters, supporting pagination, sorting, and filtering options.

Typical use cases include:

  • Automating report generation workflows by fetching specific analyzer profiles.
  • Integrating analyzer profile data into dashboards or other systems.
  • Filtering and sorting profiles for analysis or reporting purposes.

For example, you could use this node to get all published analyzer profiles related to a particular client, sorted by creation date, and paginated to handle large datasets efficiently.

Properties

Name Meaning
Agentrestriction Filter results based on agent restrictions (exact meaning depends on API implementation).
Chartonly Filter to include only chart-related profiles (boolean or flag expected).
Clientname Filter profiles by client name (string).
Count Limit the number of results returned (integer).
Includepublished Include published profiles in the results (boolean or flag).
Order Primary field to order the results by (string).
Order 2 Secondary ordering field (string).
Order 3 Tertiary ordering field (string).
Order 4 Fourth-level ordering field (string).
Order 5 Fifth-level ordering field (string).
Orderdesc Whether to order descending on primary order field (boolean or flag).
Orderdesc 2 Descending order flag for secondary order field (boolean or flag).
Orderdesc 3 Descending order flag for tertiary order field (boolean or flag).
Orderdesc 4 Descending order flag for fourth-level order field (boolean or flag).
Orderdesc 5 Descending order flag for fifth-level order field (boolean or flag).
Page No Page number for paginated results (integer).
Page Size Number of items per page (integer).
Pageinate Flag to enable or disable pagination (boolean or flag).
Reportgroup Id Filter by report group identifier (integer or string depending on API).
Search Text search filter applied to profiles (string).
Type Filter by type of analyzer profile (string or enum).

Output

The node outputs an array of JSON objects representing the analyzer profiles retrieved from the API. Each item corresponds to one analyzer profile with its associated fields as returned by the Halo PSA API.

If the API supports binary data for this operation (not indicated here), it would be included in the binary property of the output items; however, this operation appears to return only JSON data.

Example output structure (simplified):

[
  {
    "json": {
      "id": "123",
      "name": "Profile A",
      "type": "Type1",
      "published": true,
      "clientName": "ClientX",
      ...
    }
  },
  ...
]

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node uses the base URL, tenant ID, client ID, and client secret from the credentials to authenticate requests.
  • The node depends on the n8n HTTP request helper to perform API calls.
  • No additional external dependencies beyond the provided API credentials and network access to the Halo PSA service.

Troubleshooting

  • No credentials returned!: This error occurs if the required API authentication credentials are not set or invalid. Ensure that the API key credential is configured correctly in n8n.
  • Resource or Operation not found: If the specified resource or operation does not exist, verify that the correct resource ("Report Repository") and operation ("List Of Analyzer Profile") are selected.
  • API request errors: Network issues, invalid query parameters, or permission problems may cause API call failures. Check the error message returned in the node output for details.
  • Pagination issues: If too many results are requested without pagination, the API might reject the request or return incomplete data. Use Page No, Page Size, and Pageinate properties appropriately.
  • Invalid parameter types: Some properties expect specific types (e.g., integers for counts and page numbers). Providing incorrect types may cause errors.

Links and References

Discussion