CoachTrigger Dev icon

CoachTrigger Dev

Interact with coach trigger action development server API

Actions16

Overview

This node interacts with a Coach Trigger development server API to retrieve various user activity and report data. Specifically, the "Get Weekly Report DATA" operation fetches weekly report data for a specified user on a given date. This is useful in scenarios where you want to automate the retrieval of weekly performance or activity summaries for users within a coaching or employee management system.

Practical examples include:

  • Automatically generating weekly performance reports for employees.
  • Integrating weekly activity summaries into dashboards or notifications.
  • Tracking user progress over time by collecting weekly aggregated data.

Properties

Name Meaning
Authentication Choose between two authentication methods: "Company Api" (using an API key) or "System Api".
User ID The unique identifier of the user for whom the weekly report data is requested.
Date The specific date to get the weekly report data for (usually representing the week).

Output

The output is a JSON object containing the weekly report data retrieved from the API. The exact structure depends on the API response but generally includes aggregated metrics, activities, or KPIs related to the user's weekly performance.

No binary data output is produced by this operation.

Example output snippet (structure may vary):

{
  "weekStartDate": "2024-05-20",
  "weekEndDate": "2024-05-26",
  "userId": "12345",
  "activitiesSummary": [
    {
      "activityId": "act1",
      "name": "Activity Name",
      "count": 5,
      "duration": 120
    }
  ],
  "kpiValues": [
    {
      "kpiId": "kpi1",
      "value": 75
    }
  ]
}

Dependencies

  • Requires an API key credential for authentication, either as a "Company Api" or "System Api".
  • The node makes HTTP POST requests to the endpoint https://dev.mymatrixapp.com/crmApi/report/weekly-data.
  • Proper configuration of credentials in n8n is necessary to authenticate requests successfully.

Troubleshooting

  • Authentication errors: Ensure that the correct API key is provided and matches the selected authentication method.
  • Missing required parameters: The "User ID" property is mandatory; ensure it is set correctly.
  • Invalid date format: The "Date" parameter should be in a valid string format accepted by the API (typically ISO 8601).
  • API response errors: If the API returns errors, verify network connectivity and that the user ID exists in the system.
  • Parsing errors: The node expects JSON responses; if the API returns invalid JSON, the node will fail.

Links and References

Discussion