Alerts

Retrieve an alert

Returns an alert by the specified Id.

get/analytics/v1/alerts/{id}

Request

  • Base URL
    https://api.doit.com
  • URL
    https://api.doit.com/analytics/v1/alerts/{id}
  • Auth
    • API key in header Authorization
    • or API key in header X-Tenant-Id and API key in header Authorization

Path parameters

idstring required

Alert ID

Response

OK - Alert returned.

idstring

Alert ID.

namestring required

Alert Name.

createTimeinteger

The time when the alert was created (in UNIX timestamp).

updateTimeinteger

Last time the alert was modified (in UNIX timestamp).

lastAlertedinteger

Last time the alert was triggered (in UNIX timestamp).

recipientsstring[]

List of emails that will be notified when the alert is triggered.

Example response

{
  "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
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.