API Reference

Cloud Avenue Data Insights provides a comprehensive REST API for managing integrations, notifications, and other features programmatically.

You can explore the full API documentation at: https://app.cloudavenue.ai/api/docs

Authentication

All API requests require authentication using an API key. The API key must be included in the X-API-KEY header.

Creating an API Key

To create a long-lived API key for accessing the Cloud Avenue API:

Sign in to the Cloud Avenue Portal
Click on your profile avatar in the top-right corner
Select "Manage API Keys" from the dropdown menu
Click the "Add New Key" button
Provide the following details:
- Name: A descriptive name for your API key (e.g., "Production Integration")
- Description: Optional description of the key's purpose
- Expiration: Choose how long the key will be valid:
  - 7 days
  - 30 days
  - 1 year
  - Unlimited (no expiration)
Click "Save" to generate the key

Important: Save Your API Key

The API key will only be displayed once. Make sure to copy and store it securely. If you lose the key, you'll need to create a new one.

Using Your API Key

Include your API key in the X-API-KEY header of all API requests:

X-API-KEY: <YOUR_API_KEY>

Managing API Keys

You can manage your API keys at any time through the portal:

View: See all active and revoked keys with their creation and expiration dates
Revoke: Immediately disable a key if it's compromised
Delete: Permanently remove a revoked key from your account

Integrations

Curl Examples

FivetranLightdash

You will need to generate Fivetran API Key - https://fivetran.com/docs/rest-api/getting-started

curl -X POST https://app.cloudavenue.ai/api/integrations/ \
-H 'accept: application/json' \
-H 'X-API-KEY: <YOUR_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
      "name": "fivetran01",
      "type": "Fivetran",
      "connection_details": {
        "api_secret": "<FIVETRAN_API_SECRET>",
        "additional_params": {
          "api_key": "<FIVETRAN_API_KEY>"
        }
      }
}'

You will need to generate Lightdash access token - https://docs.lightdash.com/references/personal_tokens/

curl -X POST https://app.cloudavenue.ai/api/integrations/ \
-H 'accept: application/json' \
-H 'X-API-KEY: <YOUR_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
      "name": "lightdash01",
      "type": "Lightdash",
      "connection_details": {
        "api_secret": "<LIGHTDASH_API_SECRET>",
        "additional_params": {
          "base_url": "https://app.lightdash.cloud/api/v1",
          "project_uuid": "<LIGHTDASH_PROJECT_UUID>"
        }
      }
}'

Notifications

Curl Examples

Slack

You will need to generate Slack Webhook URL - https://api.slack.com/messaging/webhooks

curl -X 'POST' \
'https://app.cloudavenue.ai/api/notifications/subscriptions' \
-H 'accept: application/json' \
-H 'X-API-KEY: <YOUR_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
      "name": "slack01",
      "webhookUrl": "https://hooks.slack.com/services/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",
      "type": "slack",
      "events": [
        "pr_merged_with_impact"
      ]
}'