Get an alert

GET /api/social/v4/alerts/{alertId}

JavaScript

JavaScript

async function getAlert(alertId) {  const url = `/api/social/v4/alerts/${alertId}`;  const response = await fetch(url);  return await response.json();}

curl --request GET \
  --url https://{instance}.domo.com/api/social/v4/alerts/{alertId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{instance}.domo.com/api/social/v4/alerts/{alertId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.domo.com/api/social/v4/alerts/{alertId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{instance}.domo.com/api/social/v4/alerts/{alertId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{instance}.domo.com/api/social/v4/alerts/{alertId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.domo.com/api/social/v4/alerts/{alertId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

"HTTP/1.1 200 OK{  \"actions\": [],  \"active\": true,  \"category\": \"DATA\",  \"configurations\": [],  \"contextual\": true,  \"createdAt\": \"2024-01-01 00:00:00\",  \"createdBy\": 123456789,  \"currentUserSubscribed\": false,  \"enabled\": true,  \"error\": {},  \"filterGroups\": [],  \"id\": 123,  \"modifiedAt\": \"2024-01-01 00:00:00\",  \"modifiedBy\": 123456789,  \"name\": \"My Favorite Alert\",  \"owner\": 123456789,  \"resourceId\": \"58b3775b-ab03-4f54-9052-a3c5f7cbf426\",  \"resourceName\": \"Test Dataset\",  \"resourceType\": \"DATASET\",  \"rule\": \"Any row has changes for column(s): 'test'\",  \"subscriptions\": [],  \"triggerFrequency\": \"Rarely\",  \"triggered\": false,  \"type\": \"ANY_ROW\"}"

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

alertId · integer · required

The id of the alert you want to get

Query Parameters

fields · string

Which alert fields to include in the response

Response

200 - application/json

Returns the alert.

The response is of type object.