Alerts
List alert templates
Introduction
APIs
- Authentication
- Customers
- Accounts
- Aliases
- Event Schemas
- Usage Meters
- AddOns
- Licenses
- Feature
- (Deprecated) Price Plans
- Price Plan V2
- Settings
- Price Experimentation
- Jobs
- Event Ingestion
- Entitlements
- Event Management
- Metrics
- Credits
- Invoices
- Payments
- Wallet
- InvoiceGroups
- Alerts
- Reports
Alerts
List alert templates
Returns a list of alert templates with pagination and sort.
GET
/
alert_templates
curl --request GET \
--url https://api.togai.com/alert_templates \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "abcd-efgh-ijkl-mnop",
"name": "Alert1",
"desc": "Alert1 Description",
"entitySchema": "{\"type\":\"object\",\"properties\":{\"usageMeterId\":{\"type\":\"string\"}}}",
"entityType": "UsageMeter",
"defaultInterval": "30",
"parametersSchema": "{\"type\":\"object\",\"properties\":{\"threshold\":{\"type\":\"number\"}}}",
"ownerSchema": "{\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\"}}}",
"ownerType": "Account",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z"
}
],
"nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Response
200
application/json
Response for list Alert request
Alert Template ID
Alert Template Name
Cron Interval
Created At
Alert Template Description
Entity Schema
Entity Type
Owner Schema
Owner Type
Parameters Schema
Updated At
curl --request GET \
--url https://api.togai.com/alert_templates \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "abcd-efgh-ijkl-mnop",
"name": "Alert1",
"desc": "Alert1 Description",
"entitySchema": "{\"type\":\"object\",\"properties\":{\"usageMeterId\":{\"type\":\"string\"}}}",
"entityType": "UsageMeter",
"defaultInterval": "30",
"parametersSchema": "{\"type\":\"object\",\"properties\":{\"threshold\":{\"type\":\"number\"}}}",
"ownerSchema": "{\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\"}}}",
"ownerType": "Account",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z"
}
],
"nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="
}