The following examples are queries related to custom SQL rules, Field Health, Dimension Tracking, and JSON Schema monitors.

Please note that the sample queries below only show a subset of the fields available for brevity. You can use introspection to see all available fields.

Add Field Health, Dimension Tracking, and JSON Schema Monitors

Custom Monitors can be added via API using the createOrUpdateMonitor function.

Depending on the type of monitor you would like to setup will determine the value of the following parameters:

monitorType
Field Health - "stats"
Dimension Tracking - "categories"
JSON Schema - "json_schema"

scheduleType
Default - "LOOSE" (Note: Input intervalMinutes as 720 to check every 12 hours as default in UI)
Custom - "FIXED" (Note: Input intervalMinutes as whatever interval you would like, and include startTime in datestring format)
Dynamic - "DYNAMIC" (Note: This will check for Field Health each time we detect a table has been updated)

mutation{
  createOrUpdateMonitor(
    monitorType: "stats"
    resourceId: "dummy_warehouse_id"
    fullTableId: "project_id:schema_id.table_id"
    timeAxisType: "TIMESTAMP"
    timeAxisName: "time_field"
    scheduleConfig: {
      scheduleType: "LOOSE"
      intervalMinutes: 720
      startTime: "YYYY-MM-DDTHH:MM:SS.MMMZ"
    }
  ){
    monitor{
      id
      uuid
      createdBy
    }
  }

Create or Update Custom SQL Rules

Custom Rules can be updated via the API. Use cases include updating the description, changing the rule interval or schedule, and modifying the rule comparisons.

🚧

Create vs Update

Please note the only difference between making a new custom SQL rule and updating one is providing the rule uuid in the createOrUpdateCustomMetricRule query.

Step 1: Grab dwId
The first step is to grab your warehouse id, also known as the dwId. This is the id of the warehouse the query will be running in:

query getUser {
  getUser {
    email
    account {
      uuid
      name
      warehouses {
        uuid
        id
        createdOn
        connectionType
      }
    }
  }
}
{
  "data": {
    "getUser": {
      "email": "<email>",
      "account": {
        "uuid": "<account_uuid>",
        "name": "<account_name>",
        "warehouses": [
          {
            "uuid": "<this is the dwId you are looking for>",
            "id": "2806",
            "createdOn": "2021-03-30T22:36:25.983787+00:00",
            "connectionType": "REDSHIFT"
          }
        ]
      }
    }
  }
}

Step 2: Make the monitor
Run:

mutation {
  createOrUpdateCustomMetricRule(
    dwId: "<dwId_grabbed_by_the_above_query>"
    comparisons: [
      {
        comparisonType: THRESHOLD
        operator: GT
        threshold: 0
      }
    ]
    customSql: "<sql_query_here>"
    description: "<brief_description>"
    scheduleConfig: {
        intervalMinutes: <int for how often you want the monitor to run in minutes - for every 12 hours, this would be 720. For every 24 hours, it would be 1440>
        startTime: "<when do you want the first execution to be. If left blank, it will execute right away. Otherwise, an example input would be 2021-07-11T14:00:00+00:00>"   
    scheduleType: <Option for how often to run the checks: FIXED, LOOSE, DYNAMIC>
    }
    timezone: "UTC"
  ) {
    customRule {
      uuid
    }
  }
}

❗️

Return customRule uuid

It's important to return this in the above command! If you need to update or change your rule, this is the id you will need to rerun this command.

If you would like to view the rule after the fact, you can always run the following query with the uuid that was returned from the above query:

query {
  getCustomRule(
    ruleId: "<rule_uuid>"
  ) {
    intervalMinutes
    comparisons {
      comparisonType
      metric
      operator
      threshold
    }
    description
    timezone
    startTime
    customSql
  }
}
{
  "data": {
    "getCustomRule": {
      "intervalMinutes": 1440,
      "comparisons": [
        {
          "comparisonType": "THRESHOLD",
          "metric": "custom_metric_<rule_uuid>",
          "operator": "GT",
          "threshold": 0
        }
      ],
      "description": "Sample description",
      "timezone": "UTC",
      "startTime": "2021-06-30T19:00:00+00:00",
      "customSql": "<sql_query>"
    }
  }
}

If you are updating an existing SQL rule, you can find a list of your existing rule uuids by running:

query {
  getCustomRules (
    first: 5
    ruleType: "CUSTOM_SQL"
  ) {
    edges {
      node {
        uuid
        creatorId
        createdTime
        description
        isDeleted
        entities
        scheduleConfig {
          intervalMinutes
          startTime
        }
      }
    }
  }
}
{
  "errors": <There might be some errors here. For the most part, you can ignore!>,
  "data": {
    "getCustomRules": {
      "edges": [
        {
          "node": {
            "uuid": "<this is the uuid you are looking for>",
            "creatorId": "<email>",
            "createdTime": "2021-06-29T20:01:22.427007+00:00",
            "description": "Sample Description",
            "isDeleted": false,
            "entities": [
             "<full_table_id>"
            ],
            "scheduleConfig": {
              "intervalMinutes": 1440,
              "startTime": "2021-06-30T19:00:00+00:00"
            }
          }
        },
    ….
      ]
    }
  }
}

This query accepts the following arguments to narrow in on the rule you are looking for: before, after, first, last, and ruleType. Once you have found the necessary uuid, you can follow step 2 above to update it by adding the uuid argument in the call.

Get Incidents

To find a list of incidents in your workspace, you can run the getIncidents query. It accepts several filters:

  • dwId (UUID): Filter by a specific warehouse
  • incidentTypes (String): Filter by type of incident. The full list of accepted values is:
    • SCHEMA_CHANGES
    • DELETED_TABLES
    • CUSTOM_RULE_ANOMALIES
    • METRIC_ANOMALIES
    • ANOMALIES
  • eventTypes (String): Filter by type of event as an incident can have multiple event types
  • eventStates (String): Filter by the state individual events are in. A list of accepted values includes:
    • OPEN
    • RESOLVED
    • NO_ACTION_REQUIRED
    • MUTED
    • FALSE_POSITIVE
  • startTime (DateTime): Filter for incidents newer than this
  • endTime (DateTime): Filter for incidents older than this
  • incidentIds (UUID): Filter for specific incidents
  • projects (String): Filter by projects
  • datasets (String): Filter by datasets
  • tables (String): Filter by tables
  • fullTableIds (String): Filter by full table ids
  • first (Int)
  • last (Int)

Please note this is not an exhaustive list of filters. Contact us using the Intercom bot or at [email protected] if you would like to learn more!

query {
  getIncidents(
    last: 10
    incidentTypes: "SCHEMA_CHANGES"
    startTime: "2021-06-01T00:00Z"
  ) {
    edges {
      node {
        id
        uuid
        createdTime
        updatedTime
        project
        dataset
        incidentType
      }
    }
  }
}
{
  "data": {
    "getIncidents": {
      "edges": [
        {
          "node": {
            "id": "SW5jaWRlbnQ6MTM0NjU4",
            "uuid": "<incident_uuid>",
            "createdTime": "2021-07-22T08:41:06.640605+00:00",
            "updatedTime": "2021-07-22T08:41:05.814719+00:00",
            "project": "<project_name>",
            "dataset": "<dataset_name>",
            "incidentType": "SCHEMA_CHANGES"
          }
        },
        {
          "node": {
            "id": "SW5jaWRlbnQ6MTMzMjI2",
            "uuid": "<incident_uuid>",
            "createdTime": "2021-07-20T06:33:10.761202+00:00",
            "updatedTime": "2021-07-20T06:33:10.726695+00:00",
            "project": "<project_name>",
            "dataset": "<dataset_name>",
            "incidentType": "SCHEMA_CHANGES"
          }
        },
        ...
      ]
    }
  }
}

Create or Update Alert Notifications

You can also create or update alert routing using our createOrUpdateNotificationSetting endpoint.

There are several options to the arguments this endpoint accepts:

  • notificationType: "PAGERDUTY", "EMAIL", "MATTERMOST", "WEBHOOKS", "SLACK_V2", "OPSGENIE"
  • recipient: Destination to send notifications to. For email, provide the email address. For pagerduty, the key. For slack, the channel.
  • anomalyTypes: This argument will default to "all", meaning if you do not provide an argument, your notification will receive alerts about all anomalies. If you want to only receive a subset of alerts, you can pick and chose: "anomalies", "schema_changes", "deleted_tables", "metric_anomalies", or "custom_rule_anomalies". Provide them as an array of comma separated strings.
  • rules: This option allows you to pick a subset of custom rules or tables to send to your notification. If more than one argument, please provide them as an array of comma separated strings.
    • datasetIds: Whitelist by dataset identifiers
    • fullTableIds: Whitelist by full table identifiers
    • rulesIds: Whitelist by rule identifiers
    • tagKeys: Whitelist by tag keys
    • tagKeyValues: Whitelist by tag key/value pairs
    • tableRegex: For use in updating regex based rules

🚧

Create vs Update

Please note the only difference between making a new alert notification and updating one is providing the settingId key in the createOrUpdateNotificationSetting query.

To make a new alert notification, run the following query:

mutation {
  createOrUpdateNotificationSetting(
    notificationType: "EMAIL"
    recipient: "[email protected]"
    anomalyTypes: "anomalies"
    rules: {
      fullTableIds: ["dataset:schema.table"]
      ruleIds: ["<rule_uuid1>", "<rule_uuid2>", "<rule_uuid3>"]
    }
  ) {
    notificationSetting {
      id
      uuid
    }
  }
}

❗️

Return notification uuid

It's important to return this in the above command! If you need to update or change your rule, this is the id you will need to rerun this command.

If you want to update an existing notification, you will need a settingId of an existing notification setting. You can return all existing notification settings by running the getUser query:

query getUser {
  getUser {
    email
    account {
      uuid
      notificationSettings {
        uuid
        type
        recipient
        anomalyTypes
        routingRules {
          uuid
          tableRules
          sqlRules
        }
      }
    }
  }
}
{
  "data": {
    "getUser": {
      "email": "[email protected]",
      "account": {
        "uuid": "<account_uuid>",
        "notificationSettings": [
          {
            "uuid": "<settingId>",
            "type": "EMAIL",
            "recipient": "[email protected]",
            "anomalyTypes": [
              "custom_rule_anomalies"
            ],
            "routingRules": {
              "uuid": "<route_uuid>",
              "tableRules":  [
                "dataset:schema.table"
              ],
              "sqlRules": [
                "<rule_uuid>"
              ]
            }
          }
        ]
      }
    }
  }
}

After you found the settingId, run the createOrUpdateNotificationSetting query to update the notification route.

If you want to get a list of all existing SQL rule UUIDs to provide into the createOrUpdateNotificationSetting query, run:

query {
  getCustomRules(first: 20) {
    edges {
      node {
        uuid
        ruleType
        description
      }
    }
  }
}
{
  "data": {
    "getCustomRules": {
      "edges": [
        {
          "node": {
            "uuid": "<rule_uuid>",
            "ruleType": "CUSTOM_SQL",
            "description": "Katie Noonan's Testing Rule"
          }
        },
        {
          "node": {
            "uuid": "<rule_uuid>",
            "ruleType": "CUSTOM_SQL",
            "description": "Another Test Rule"
          }
        }
      ]
    }
  }
}

This query accepts the following arguments to narrow in on the rule you are looking for: before, after, first, last, and ruleType.


Did this page help you?