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
This node enables creating a new Key Performance Indicator (KPI) within the Flowyteam system. KPIs are measurable values that demonstrate how effectively an individual, team, or organization is achieving key business objectives. This node is useful for automating the addition of KPIs into your performance management workflows, such as tracking sales targets, customer satisfaction scores, or operational efficiency metrics.
Practical examples include:
- Automatically creating monthly sales KPIs when a new sales campaign starts.
- Adding KPIs for employee performance evaluation based on project completion rates.
- Setting up quarterly financial KPIs to monitor revenue growth.
Properties
| Name | Meaning |
|---|---|
| Category | The category under which the KPI falls (e.g., Sales, Marketing, Operations). |
| Title | The title or name of the KPI (e.g., "Monthly Revenue"). |
| Type | The type of KPI, indicating what kind of metric it represents. |
| Occurrence | How often the KPI is measured or updated. Options: Daily, Weekly, Monthly, Quarterly. |
| View Options | Configuration options for how the KPI is displayed or viewed in the system. |
| Aggregate | The aggregation method used to calculate the KPI value. Options: Average, Count, Max, Min, Sum. |
| Additional Fields | A collection of optional fields to provide more details about the KPI: |
| - Calculated Value | The computed value of the KPI. |
| - Color Range | Color coding range for visual representation of KPI status. |
| - Description | A textual description explaining the KPI. |
| - Employee Access | Comma-separated list of employee IDs who can 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 | Sorting order for displaying the KPI. |
| - Target Value | The target or goal value for the KPI. |
| - Team | The team associated with this KPI. |
| - Unit Value | The unit of measurement for the KPI (e.g., %, $, units). |
Output
The node outputs JSON data representing the newly created KPI object as returned by the Flowyteam API. This typically includes all the properties of the KPI such as its unique identifier, category, title, type, occurrence, aggregate method, and any additional fields set during creation.
No binary data output is involved.
Dependencies
- Requires an active connection to the Flowyteam API via an API authentication token configured in n8n credentials.
- The node depends on the Flowyteam service being available and accessible from the environment where n8n runs.
Troubleshooting
Common Issues:
- Missing required fields such as Category, Title, Type, Occurrence, View Options, or Aggregate will cause the operation to fail.
- Invalid values for enumerated fields like Occurrence or Aggregate may result in API errors.
- Network connectivity issues or invalid API credentials will prevent successful KPI creation.
Error Messages:
- Errors indicating missing parameters suggest checking that all required inputs are provided.
- Authentication errors imply verifying the API key credential setup.
- Validation errors from the API usually mean some input values do not conform to expected formats or constraints.
Resolving these typically involves ensuring all required properties are correctly filled, validating option selections, and confirming API credentials and network access.
Links and References
- Flowyteam Official Documentation (for detailed API and KPI concepts)
- n8n Documentation (for general guidance on using custom nodes and credentials)