GateKit icon

GateKit

Universal messaging gateway - send messages across multiple platforms

Overview

This node operation allows you to retrieve platform processing logs for a specified project and platform configuration. It is useful for monitoring, debugging, and auditing activities related to messaging platforms integrated into your project. You can filter logs by platform type (e.g., Telegram, Discord), log level (info, warn, error, debug), category (connection, webhook, message, error, auth, general), and date ranges. This helps in pinpointing issues or understanding system behavior over time.

Practical examples:

  • Fetch recent error logs from the Telegram platform to investigate message delivery failures.
  • Retrieve all warning and error logs for a specific platform configuration within a given date range.
  • Monitor authentication-related logs to audit access attempts.

Properties

Name Meaning
Platform Filter logs by platform type; options include telegram, discord.
Level Filter logs by severity level; options are info, warn, error, debug.
Category Filter logs by category; options include connection, webhook, message, error, auth, general.
Start Date Filter logs that occurred after this ISO 8601 date/time.
End Date Filter logs that occurred before this ISO 8601 date/time.
Limit Number of logs to return; valid range is 1 to 1000. Default is 100.
Offset Number of logs to skip (for pagination).
Project Identifier of the project to operate on. This is required.
PlatformId Identifier of the specific platform configuration to fetch logs for. This is required.

Output

The node outputs JSON data containing an array of log entries matching the specified filters. Each log entry typically includes details such as timestamp, log level, category, message content, and possibly additional metadata related to the platform event.

If binary data were involved (not indicated here), it would represent raw log files or attachments, but this node focuses on JSON log data.

Dependencies

  • Requires an API key credential with appropriate permissions to access project and platform logs.
  • The node makes HTTP GET requests to the GateKit API endpoint corresponding to the project's platform logs.
  • The base URL and authentication headers are configured via the node's credentials.

Troubleshooting

  • Empty results: Ensure the project and platformId parameters are correct and that logs exist for the specified filters and date range.
  • Invalid date format: Dates must be in ISO 8601 format; otherwise, the API may reject the request.
  • Permission errors: Verify that the API key used has sufficient rights to read platform logs for the project.
  • Limit and offset misuse: Using very high offsets without sorting might lead to unexpected results; use reasonable pagination values.
  • API connectivity issues: Check network connectivity and that the API URL in credentials is correct.

Links and References

Discussion