Advanced Guide: Enabling Big Query for a Custom Alert

Overview

This presentation will walk you through how to enable Big Query for custom alerts.

Steps to Enable a Custom Alert Using BigQuery in the Alli Data API

Prerequisites

1. API Client: Ensure you have an API client like Postman or Talend for Chrome installed.

   1. Talend API Tester

   2. Postman

2. API Token: Obtain an API token from your Alli Central user profile and use it for authentication in your API requests.

3. Endpoint URL: All API calls will use the base URL <https://dataexplorer.alliplatform.com>

Step-by-Step Guide

Setting up your client

1. Set the call method to PATCH.

2. Set the URL to https://dataexplorer.alliplatform.com/api/alert/{alertid}.

3. Set the Authorization:

   • Obtain your API v2 access token from the Alli Central user profile at https://central.alliplatform.com/me.

   • Use the browser's developer tools to view the request details for the /me request.

1. Include the token in the Authorization header of your API requests:

   Authorization: Bearer [API_TOKEN]
   

2. Set the body request to specify BigQuery as the alert's database:

   {
     "databaseType": "bigquery",
     "tags": [
       "BigQuery"
     ]
   }
   

Talend API Tester example:

** Method should be `PATCH`

Postman Example

Setting up your client

1. Create an alert through the Alli UI

2. Edit the alert using your API client:

Now that you have created your alert, you can use the API call you set up earlier to update this alert to use BigQuery.

PATCH https://dataexplorer.alliplatform.com/api/alert/{alertid}

3. Replace {alertid} with the ID of your alert, which can be found in the URL when you navigate to the alert.

4. Send the API Request.

5. Verify the Alert Creation

   • If the alert is successfully created, the API will return a response with a status of "Success" and details of the created alert.

   • Example response:

     JSON

     {
       "status": "Success",
       "alert": {
         "id": "5f8d0d55b54764421b7156c3",
         "projectId": "6026d98e3081300006b57d58",
         "databaseType": "bigquery",
         "tags": ["BigQuery"],
         "createdAt": "2024-07-29T10:12:34.567Z",
         ...
       }
     }
     

Example API Request in Postman

• Method: PATCH

• URL: <https://dataexplorer.alliplatform.com/api/alert/{alertid}>

• Headers:

  Authorization: Bearer [API_TOKEN]
  Content-Type: application/json
  

• Body:

  JSON

  {
    "databaseType": "bigquery",
    "tags": [
      "BigQuery"
    ]
  }
  

  
  

This documentation should guide you through enabling a custom alert using BigQuery in the Alli Data API efficiently.

Related articles