CoachTrigger Dev icon

CoachTrigger Dev

Interact with coach trigger action development server API

Activity → Get User KPIs List

AI-generated

Overview

This node interacts with a Coach Trigger development server API to retrieve and manage user-related activity data, including KPIs (Key Performance Indicators). Specifically, the "Get User KPIs List" operation fetches a list of KPIs associated with a specified user. This is useful in scenarios where you want to monitor or analyze user performance metrics within a coaching or team management context.

Practical examples:

  • Fetching all KPI metrics for a user to display on a dashboard.
  • Integrating KPI data into reports or notifications.
  • Using KPI lists to trigger further automation based on user performance.

Properties

Name Meaning
Authentication Choose between two authentication methods: "Company Api" or "System Api".
User ID The unique identifier of the user whose KPI list you want to retrieve.

Output

The output is a JSON object containing the response from the API endpoint that provides the user's activities and KPIs. The structure depends on the external API but generally includes an array or list of KPI objects related to the user.

No binary data output is produced by this operation.

Example output JSON snippet (conceptual):

{
  "kpis": [
    {
      "kpiId": "123",
      "name": "Sales Target",
      "value": 75,
      "date": "2024-06-01"
    },
    {
      "kpiId": "124",
      "name": "Customer Satisfaction",
      "value": 90,
      "date": "2024-06-01"
    }
  ]
}

Dependencies

  • Requires an API key credential depending on the selected authentication method ("Company Api" or "System Api").
  • The node makes HTTP POST requests to https://dev.mymatrixapp.com/crmApi/user/activities.
  • Proper configuration of credentials in n8n is necessary to authenticate requests.

Troubleshooting

  • Authentication errors: Ensure the correct API key or system key is provided and valid.
  • Missing or invalid User ID: The User ID property is required; missing or incorrect values will cause the API call to fail.
  • API response parsing errors: If the API returns unexpected data or errors, the node may fail to parse the response. Check the API status and request parameters.
  • Network issues: Verify network connectivity to the API endpoint.

Links and References

  • No direct external links are provided in the source code. For more information, consult the documentation of the Coach Trigger API or your organization's API reference for user activities and KPIs.

Discussion