WibiClick

Interact with WibiClick API

Actions92

Overview

The node integrates with the WibiClick API to manage various resources such as jobs, contacts, employees, invoices, and more. Specifically for the Job resource with the Get Analytics operation, it retrieves analytics data related to jobs for a specified website, year, and month.

This operation is useful for businesses or service providers who want to analyze job-related metrics over time, such as monthly performance, trends, or workload distribution. For example, a company managing field service jobs can use this to monitor how many jobs were completed in a given month or track job statuses to optimize operations.

Properties

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

These properties must be provided to specify the scope of the analytics query.

Output

The output JSON contains the analytics data returned by the WibiClick API for the specified website, year, and month. The exact structure depends on the API response but generally includes aggregated job metrics such as counts, statuses, or other relevant statistics.

Example output structure (illustrative):

{
  "totalJobs": 120,
  "completedJobs": 100,
  "pendingJobs": 15,
  "cancelledJobs": 5,
  "month": 1,
  "year": 2024,
  "websiteId": "d0cfa1ac-fd6f-48e8-b9e6-fac599a0430b"
}

No binary data is involved in this operation.

Dependencies

Requires an active connection to the WibiClick API.
An API key credential must be configured in n8n to authenticate requests.
The node uses HTTP GET requests to fetch analytics data from the endpoint /job-analytics.

Troubleshooting

Missing Parameters: Ensure that Website ID, Year, and Month are all provided and valid. Missing or invalid parameters will cause the request to fail.
API Authentication Errors: If the API key is missing, invalid, or expired, the node will fail to authenticate. Verify the API key credential configuration.
Invalid Date Values: The Month must be between 1 and 12; values outside this range may cause errors.
Network Issues: Connectivity problems to the WibiClick API endpoint will result in request failures.
Unexpected API Responses: If the API returns an error or unexpected data, check the API status and ensure the website ID exists and has data for the requested period.

Links and References

WibiClick API Documentation (Assumed URL, replace with actual if available)
n8n Documentation on HTTP Request Node
General guidance on Using API Credentials in n8n

This summary focuses on the Job - Get Analytics operation extracted from the provided source code and property definitions.

WibiClickInstall