Skip to content

API Reference

If you would like to use our API to connect integrations or enable notifications, send a request with the required details. You can use any REST API client or refer to the instructions provided on this page: https://insights.cloudavenue.ai/api/docs

How to retrieve <AUTH_TOKEN>

Upon logging into the Cloud Avenue portal, open the developer console (usually accessed by pressing F12), navigate to the Application tab, and locate your access_token.

Integrations

Curl Examples

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

curl -X POST https://insights.cloudavenue.ai/api/integrations/ \
-H 'accept: application/json' \
-H 'Authorization: Bearer <AUTH_TOKEN>' \
-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://insights.cloudavenue.ai/api/integrations/ \
-H 'accept: application/json' \
-H 'Authorization: Bearer <AUTH_TOKEN>' \
-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

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

curl -X 'POST' \
'https://insights.cloudavenue.ai/api/notifications/subscriptions' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <AUTH_TOKEN>' \
-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"
      ]
}'