WibiClick icon

WibiClick

Interact with WibiClick API
Join our community

Actions92

Overview

The node integrates with the WibiClick API to manage various resources such as contacts, jobs, notes, employees, estimates, invoices, line items, websites, WhatsApp messages, users, technicians, tasks, suppliers, and settings. Specifically for the Contact resource with the Get Metrics operation, it retrieves customer metrics data for a specified website and time period (year and month). This is useful for analyzing customer-related performance indicators or trends over time.

Common scenarios include:

  • Monitoring customer engagement or activity metrics on a website.
  • Generating monthly or yearly reports about customer behavior.
  • Integrating customer metrics into automated workflows for business intelligence or marketing purposes.

Example: Fetching customer metrics for a website in January 2024 to analyze customer interactions and improve service offerings.

Properties

Name Meaning
Website ID The unique identifier of the website for which customer metrics are requested.
Year The year for which the metrics data should be retrieved (e.g., 2024).
Month The month (1-12) within the specified year for which metrics are requested.

Output

The output JSON contains the customer metrics data returned by the WibiClick API for the specified website and time period. The exact structure depends on the API response but generally includes aggregated metrics related to customers, such as counts, trends, or other analytics data relevant to customer activity.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the WibiClick API.
  • Requires an API key credential for authentication with the WibiClick service.
  • The node uses HTTP requests to communicate with the WibiClick API endpoints.
  • No additional environment variables or external services are required beyond the API key.

Troubleshooting

  • Invalid or missing Website ID: Ensure the Website ID is correctly provided and corresponds to an existing website in WibiClick.
  • Incorrect Year or Month values: Year should be a valid number (e.g., 2024), and Month must be between 1 and 12.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • API request failures: Network issues or API downtime can cause errors; check connectivity and WibiClick service status.
  • Unexpected API responses: If the API returns unexpected data or errors, review the API documentation or contact support.

Common error messages:

  • "Failed to retrieve customer metrics" (implied if API response is invalid or empty).
  • HTTP 401 Unauthorized if the API key is invalid.
  • HTTP 400 Bad Request if parameters are malformed.

Links and References

Discussion