v1
latestOpenAPI 3.0.12026-07-26152262362.2 KBAlerts
List alerts
Returns a list of alerts that your account has access to. Alerts are listed in reverse chronological order by default.
get/analytics/v1/alerts
Query parameters
sortBy'name' | 'createTime' | 'updateTime' | 'lastAlerted'
A field by which the results will be sorted.
sortOrder'asc' | 'desc'
Sort order can be ascending or descending.
maxResultsstring
The maximum number of results to return in a single page. Use the page tokens to iterate through the entire collection.
pageTokenstring
Page token, returned by a previous call, to request the next page of results
filterstring
An expression for filtering the results. The syntax is key:[<value>]. Multiple filters can be connected using a pipe |. See Filters. Available filter keys: owner, name
Response
OK - The request succeeded.
Example response
{
"pageToken": "bDl0QkEwVFZxUEwxaUJRaHhTcXM",
"rowCount": 1,
"alerts": [
{
"id": "7jyrczd6CSh3M8TuQ6Qq",
"name": "fgfgh",
"createTime": 1678628817062,
"updateTime": 1678628938891,
"lastAlerted": null,
"recipients": [
"user1@example.com",
"user2@example.com"
],
"config": {
"condition": "value",
"currency": "USD",
"metric": {
"type": "basic",
"value": "cost"
},
"operator": "gt",
"evaluateForEach": "",
"attributions": [
"PvqyGcdFcTHh7aLUdGdf"
],
"scopes": [],
"timeInterval": "month",
"dataSource": "billing",
"value": 500
}
}
]
}