GateKit icon

GateKit

Universal messaging gateway - send messages across multiple platforms

Actions26

Overview

The node provides access to message-related data and operations within a messaging gateway platform. Specifically, the Stats operation under the Messages resource retrieves statistical information about messages for a specified project. This can be useful for monitoring message volumes, analyzing communication patterns, or generating reports on messaging activity.

Practical examples include:

  • Getting an overview of how many messages were sent or received in a project.
  • Tracking message trends over time for performance or usage analysis.
  • Integrating message statistics into dashboards or automated workflows for alerting or auditing.

Properties

Name Meaning
Project Slug Project identifier to operate on (string). This specifies which project's message statistics to retrieve. Default is "default".

Output

The output JSON contains the message statistics data returned by the API endpoint /api/v1/projects/{projectSlug}/messages/stats. While the exact structure depends on the external service's response, it typically includes aggregated counts or metrics related to messages such as total messages, messages per platform, success/failure rates, or other relevant statistics.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authentication with the messaging gateway API.
  • The node makes HTTP GET requests to the base URL configured in the credentials, specifically to the endpoint /api/v1/projects/{projectSlug}/messages/stats.
  • Proper configuration of the API URL and valid credentials are necessary for successful operation.

Troubleshooting

  • Common issues:

    • Invalid or missing project slug: Ensure the Project Slug property is correctly set to an existing project identifier.
    • Authentication errors: Verify that the API key credential is valid and has appropriate permissions.
    • Network or connectivity problems: Confirm that the API URL is reachable from the n8n environment.

  • Error messages:

    • Unauthorized or 401 errors indicate invalid or missing API credentials.
    • 404 errors may mean the specified project does not exist.
    • 500 or server errors suggest issues on the API provider side; retry later or contact support.

Resolving these usually involves checking input parameters, credentials, and network settings.

Links and References

Discussion