Skip to main content
GET
/
api
/
social
/
v4
/
alerts
JavaScript
async function getAlerts() {  const url = `/api/social/v4/alerts`;  const response = await fetch(url);  return await response.json();}
"HTTP/1.1 200 OKContent-Type: application/json{  [    {        \"id\": 358,        \"name\": \"Any row has changes for column(s): 'embedURL, metric, src, filesAPINum, docId, userName, title'\",        \"type\": \"ANY_ROW\",        \"resourceType\": \"DATASET\",        \"resourceId\": \"58b3775b-ab03-4f54-9052-a3c5f7cbf426\",        \"createdAt\": \"2024-12-12 23:37:32\",        \"createdBy\": 1341393147,        \"modifiedAt\": \"2024-12-13 18:55:17\",        \"modifiedBy\": 1341393147,        \"category\": \"DATA\"    }, ...  ]}"

Authorizations

Authorization
string
header
required

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

Query Parameters

all
boolean

Whether to fetch all alerts at once

cardId
integer

A specific card id to fetch alerts for

currentUserSubscriptions
boolean
default:false

Whether to fetch the alerts subscribed to by the current user

dataSetId
string

A specific dataset id to fetch alerts for

disabled
boolean

Whether to fetch only disabled alerts

fields
string
default:id, category, type, name, description, resourceType, resourceId, createdAt, createdBy, modifiedAt, modifiedBy

Which alert fields to include in the response (can be set to 'all' to fetch all fields)

limit
integer
default:100

The query limit

offset
integer
default:0

The query offset (for pagination)

ownerId
integer

A specific user id to fetch owned alerts for

pageId
integer

A specific page id to fetch alerts for

sort
string
default:createdAt

The field to sort by

subscriberId
integer

A specific user id to fetch subscribed alerts for

subscriptionTypes
string

A list of subscription types to filter the alerts by

suggested
boolean

Whether to fetch only alerts that are suggested for you

triggered
string

Whether to fetch only alerts that have been triggered

Response

200 - application/json

Returns the alerts based on the included query params.

The response is of type object.