Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Analyzer Profile → Get One Analyzer Profile

AI-generated

Overview

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

Typical use cases include:

  • Fetching detailed analytics profiles for clients or dashboards within a PSA system.
  • Automating reporting workflows by retrieving profile data programmatically.
  • Integrating PSA profile data into other systems or dashboards for enhanced visibility.

For example, you might use this node to get an analyzer profile by its ID and include additional details such as report access tokens or specify a reporting period to tailor the returned data.

Properties

Name Meaning
Id The unique identifier (number) of the Analyzer Profile to retrieve.
Client Id Optional client identifier to filter or associate the profile request.
Clientname Optional client name string to filter the profile retrieval.
Dashboard Id Optional dashboard identifier to filter the profile.
Dashboard Published Id Optional published dashboard identifier string.
Dontloadsystemreport Optional flag to exclude loading the system report.
Getcompositetoken Optional flag to request a composite token in the response.
Includedetails Optional flag to include detailed information in the response.
Invoice Id Optional invoice identifier to filter the profile data.
Loadreport Optional flag to load the associated report.
Report Access Token Optional string token used for accessing reports securely.
Reportingperiod Optional 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 response from the Halo PSA service for the requested profile, including any additional details or report data if requested.

Output example (simplified):

{
  "id": 123,
  "client_id": 456,
  "profile_name": "Example Profile",
  "details": { /* detailed info if included */ },
  "report": { /* report data if loaded */ }
}

No binary data output is produced by this operation.

Dependencies

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

Troubleshooting

  • Missing Credentials: If no credentials are provided or invalid, the node will throw an error indicating missing credentials. Ensure that valid API authentication details are configured.
  • Resource or Operation Not Found: Errors occur if the specified resource or operation does not exist. Verify that "Analyzer Profile" and "Get One Analyzer Profile" are correctly selected.
  • Invalid or Missing Id: Since "Id" is required, omitting it or providing an invalid value will cause the API call to fail. Always provide a valid numeric ID.
  • API Request Failures: Network issues, incorrect base URL, or invalid authentication can cause request failures. Check connectivity and credential correctness.
  • JSON Parsing Errors: If any JSON parameters are malformed, the node may throw parsing errors. Validate JSON inputs if used.

Using the "Continue On Fail" option allows the workflow to proceed even if some requests fail, returning error messages in the output JSON.

Links and References

Discussion