UniFi Site Manager icon

UniFi Site Manager

Manage UniFi devices and networks through the Site Manager API
Join our community

Actions5

Overview

The node "UniFi Site Manager" allows users to retrieve ISP metrics data from the UniFi Site Manager API. Specifically, the "Get" operation under the "ISP Metrics (Early Access)" resource fetches performance metrics aggregated over specified time intervals and durations. This is useful for network administrators or analysts who want to monitor ISP performance trends, troubleshoot connectivity issues, or generate reports on network quality over time.

Typical use cases include:

  • Monitoring ISP latency, packet loss, or throughput in 5-minute or 1-hour intervals.
  • Analyzing historical ISP performance over the last day, week, or month.
  • Custom querying of ISP metrics within a specific time range for detailed analysis.

Properties

Name Meaning
Type The time interval for metrics collection. Options: "5 Minutes" (24h duration), "1 Hour" (7d or 30d duration)
Duration Duration for which metrics are retrieved. For "5 Minutes" type: "24 Hours". For "1 Hour" type: "7 Days" or "30 Days". Optional; if not set, custom timestamps can be used.
Begin Timestamp Start time for a custom time range in RFC3339 format. Only used when Duration is not specified.
End Timestamp End time for a custom time range in RFC3339 format. Only used when Duration is not specified.

Output

The node outputs JSON data containing ISP metrics aggregated according to the selected time interval and duration or custom time range. The structure typically includes timestamped metric entries such as latency, packet loss, bandwidth usage, or other ISP-related performance indicators.

If binary data output is supported, it would represent raw metric files or logs, but based on the provided information, the output is primarily structured JSON metric data.

Dependencies

  • Requires an API key credential for authenticating with the UniFi Site Manager API.
  • The node communicates with the UniFi Site Manager API endpoint at https://api.ui.com.
  • Proper configuration of the API authentication token in n8n credentials is necessary.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect date/time formats for custom timestamps may result in errors or empty responses.
    • Requesting unsupported durations or intervals might lead to API errors.

  • Error Messages:

    • Authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
    • Validation errors on timestamps: Ensure that Begin and End Timestamps follow RFC3339 format and that Begin is before End.
    • Empty or incomplete data: Check that the requested duration and interval combination is supported by the API.

Links and References

Discussion