Actions22
Report → Get
AI-generatedOverview
This node interacts with the Supportpal REST API to retrieve report data based on specified parameters. Specifically, for the 'Report' resource and 'Get' operation, it fetches a report by its category and name. This is useful for automating the retrieval of specific reports from Supportpal, such as fetching sales reports, user activity reports, or system status reports by specifying their category and name.
Use Case Examples
- Fetch a sales report by specifying the category as 'sales' and the report name as 'monthly_summary'.
- Retrieve a user activity report by setting the category to 'user' and the report name to 'activity_log'.
Properties
| Name | Meaning |
|---|---|
| Category | The category the report is in. This is a required string input that specifies the report's category to fetch. |
| Name | The name of the report. This is a required string input that specifies the exact report to retrieve within the given category. |
| Simplify Response | A boolean option to return a simplified response containing only the message data, making it easier to work with the output. |
Output
JSON
data- The main data of the retrieved report from Supportpal API, either full or simplified based on the 'Simplify Response' option.
Dependencies
- Requires an API key credential for Supportpal API authentication to make authorized requests.
Troubleshooting
- Ensure the 'Category' and 'Name' fields are correctly specified and correspond to existing reports in Supportpal; otherwise, the API may return errors or empty results.
- If the API key credential is invalid or missing, the node will fail to authenticate and retrieve data.
- Network issues or incorrect API endpoint paths may cause request failures; verify connectivity and API base URL configuration.
Links
- Supportpal API Documentation - Official documentation for Supportpal REST API endpoints and usage.