Actions101
- Attendance Actions
- Client Actions
- Department Actions
- Designation Actions
- Employee Actions
- Holiday Actions
- KPI Actions
- KPI Category Actions
- KPI Data Actions
- Lead Actions
- Leave Actions
- OKR Key Result Actions
- OKR Objective Actions
- Performance Cycle Actions
- Project Actions
- Project Category Actions
- Task Actions
- Task Category Actions
- Ticket Actions
- Ticket Agent Actions
- Ticket Channel Actions
- Ticket Type Actions
Overview
The node's execute() method for the KPI resource with the Update operation allows users to update an existing Key Performance Indicator (KPI) in the Flowyteam system. This operation is useful for modifying details of a KPI such as its category, title, type, occurrence frequency, aggregation method, and other optional attributes.
Typical use cases include:
- Adjusting KPI parameters to reflect changes in business goals or measurement criteria.
- Updating descriptive information or access controls for KPIs.
- Changing how KPI data is aggregated or displayed without recreating the KPI from scratch.
For example, a user might update a KPI's occurrence from "Monthly" to "Weekly" to get more frequent performance insights, or change the aggregate function from "Sum" to "Average" to better represent the data.
Properties
| Name | Meaning |
|---|---|
| KPI ID | The unique identifier of the KPI to update. |
| Category | The category under which the KPI is classified. |
| Title | The name or title of the KPI. |
| Type | The type of KPI being tracked (e.g., sales, customer satisfaction). |
| Occurrence | How often the KPI is measured or updated. Options: Daily, Weekly, Monthly, Quarterly. |
| View Options | Configuration options that determine how the KPI is viewed or presented. |
| Aggregate | The aggregation method used for the KPI values. Options: Average, Count, Max, Min, Sum. |
| Additional Fields | A collection of optional fields to further customize the KPI: |
| - Calculated Value | A string representing a calculated value related to the KPI. |
| - Color Range | A color setting to visually represent KPI ranges. |
| - Description | A textual description providing more context about the KPI. |
| - Employee Access | Comma-separated list of employee IDs who have permission to access this KPI. |
| - KPI Parent ID | Identifier of a parent KPI if this KPI is part of a hierarchy. |
| - Personal | Personalization settings for the KPI. |
| - Sort | Defines the sort order of the KPI when listed. |
| - Target Value | The target or goal value for the KPI. |
| - Team | The team associated with or responsible for the KPI. |
| - Unit Value | The unit of measurement for the KPI values (e.g., %, $, units). |
Output
The output of the node after executing the update operation is a JSON object representing the updated KPI record as returned by the Flowyteam API. This typically includes all the KPI properties such as ID, category, title, type, occurrence, aggregate method, and any additional fields set during the update.
No binary data output is involved in this operation.
Dependencies
- Requires an active connection to the Flowyteam API via an API key credential configured in n8n.
- The node depends on the Flowyteam API endpoints for managing KPIs.
- Proper permissions are required on the API key to perform update operations on KPIs.
Troubleshooting
Common Issues:
- Providing an invalid or non-existent KPI ID will result in an error indicating the KPI could not be found.
- Missing required fields such as KPI ID, category, title, type, occurrence, or aggregate will cause validation errors.
- Incorrect formatting of additional fields like employee access (should be comma-separated IDs) may lead to unexpected behavior.
- Insufficient API permissions can cause authorization errors.
Error Messages:
"The operation 'update' is not supported for KPI resource": This indicates a misconfiguration or unsupported operation; ensure the operation and resource are correctly selected.- API errors related to authentication or authorization suggest checking the API key credentials.
- Validation errors from the API usually specify which required field is missing or malformed.
Resolution Tips:
- Double-check all required input properties are provided and correctly formatted.
- Verify the KPI ID exists in the Flowyteam system before attempting an update.
- Ensure the API key has the necessary scopes/permissions.
- Review the Flowyteam API documentation for correct field formats and constraints.
Links and References
- Flowyteam API Documentation (general reference for API endpoints and data models)
- n8n Documentation (for configuring credentials and using custom nodes)