Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Report Repository → Get One Analyzer Profile

AI-generated

Overview

This node interacts with the "Report Repository" resource of the Halo PSA API to retrieve detailed information about a specific Analyzer Profile. The operation "Get One Analyzer Profile" fetches data for a single profile identified by its unique Id, optionally filtered or enriched by various query parameters.

Typical use cases include:

  • Retrieving detailed analytics profiles for reporting or dashboarding purposes.
  • Integrating report data into workflows for automated processing or notifications.
  • Fetching specific analyzer profile details based on client, dashboard, invoice, or reporting period criteria.

For example, you might use this node to get an analyzer profile by its Id and filter it by a client name or dashboard id to tailor reports dynamically in your automation.

Properties

Name Meaning
Id The unique identifier (number) of the analyzer profile to retrieve.
Client Id Optional query parameter to filter the profile by a specific client identifier.
Clientname Optional query parameter to filter by the client's name.
Dashboard Id Optional query parameter to specify a particular dashboard identifier.
Dashboard Published Id Optional query parameter for filtering by published dashboard identifier.
Dontloadsystemreport Optional flag to exclude loading system reports.
Getcompositetoken Optional flag to request a composite token related to the profile.
Includedetails Optional flag to include additional details in the response.
Invoice Id Optional query parameter to filter by a specific invoice identifier.
Loadreport Optional flag to indicate whether to load the associated report.
Report Access Token Optional string token used for accessing the report securely.
Reportingperiod Optional query parameter specifying the reporting period.
Reportingperiodenddate Optional string date marking the end of the reporting period.
Reportingperiodstartdate Optional string date marking the start of the reporting period.

All optional properties are sent as query parameters to the API when provided.

Output

The node outputs JSON data representing the retrieved analyzer profile. The structure corresponds directly to the API's response for the requested profile, including any additional details or tokens if requested.

  • The output JSON contains all fields returned by the API for the analyzer profile.
  • If errors occur during the request, the output JSON will contain an error field with the error message.
  • No binary data is output by this node.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node uses credentials that provide base URL, tenant, client ID, and client secret for API access.
  • No other external dependencies are required beyond the configured API credentials.

Troubleshooting

  • No credentials returned!
    This error indicates missing or misconfigured API authentication credentials. Ensure the API key credential is properly set up in n8n.

  • Resource or Operation not found
    Occurs if the specified resource or operation does not exist in the node configuration. Verify that "Report Repository" and "Get One Analyzer Profile" are correctly selected.

  • API request errors
    Network issues, invalid parameters, or permission problems may cause API request failures. Check the error message returned in the output JSON for details.

  • JSON parsing errors
    If using advanced JSON parameters, ensure they are valid JSON strings.

Links and References

Discussion