Documentation

n8n      AvantGuard

SaaS Alerts - External Partner - Processed Events Data n8n Node

n8n community node npm

OverviewThe Reports API allows partners to query SaaS Alerts for processed event data.In other words, event data that's been processed from its raw format from its source and enriched with additional information.# Getting StartedTo get started with the SaaS Alerts API, follow these steps:1. Obtain an API key by navigating to Settings > API in the SaaS Alerts dashboard, and clicking on the “Show key” button under Manage API.2. Use the API key to authenticate requests to the API and start using our services. See the documentation for details on the available endpoints, request/response structures, and authentication mechanisms.# SupportIf you have any questions or need further assistance, please don’t hesitate to contact our support team. We are always here to help!

Table of Contents

Installation

Follow the n8n community node installation guide.

Or install directly via npm:

npm install @avantguardllc/n8n-nodes-saasalertsexternalpartnerprocessedeventsdata

Authentication

This node authenticates using an API Key.

Setting Value
Type API Key
Sent in header
Header / Query name api_key
Base URL https://us-central1-the-byway-248217.cloudfunctions.net/reportApi/api/v1 (editable in credentials)

Tip: The Base URL can be changed in the credential settings if your instance uses a different host.

Resources & Operations

Base URL: https://us-central1-the-byway-248217.cloudfunctions.net/reportApi/api/v1

Reports

Endpoint Description
🟢 POST /reports/events/query Event Data
🟢 POST /reports/events/count/query Events - count

Compatibility

  • n8n version: 1.0+ (tested on 2.x)
  • Node.js version: 18+

License

MIT

Discussion