Benachrichtigung erstellen

Version 4.0.23.6 (neueste Version)

Neue Benachrichtigung erstellen und Details zum neu erstellten Objekt zurückgeben

Pflichtfelder: field, destinations, comparison_type, threshold, cron

Beispielanfrage: Führen Sie jeden Tag um 5 Uhr eine Benachrichtigung für das Dashboard-Element „103“ aus. Eine E-Mail an test@test.com senden,wenn das Inventar für Los Angeles (mit dem Dashboard-Filter Warehouse Name) kleiner als 1.000 ist

{
  "cron": "0 5 * * *",
  "custom_title": "Alert when LA inventory is low",
  "dashboard_element_id": 103,
  "applied_dashboard_filters": [
    {
      "filter_title": "Warehouse Name",
      "field_name": "distribution_centers.name",
      "filter_value": "Los Angeles CA",
      "filter_description": "is Los Angeles CA"
    }
  ],
  "comparison_type": "LESS_THAN",
  "destinations": [
    {
      "destination_type": "EMAIL",
      "email_address": "test@test.com"
    }
  ],
  "field": {
    "title": "Number on Hand",
    "name": "inventory_items.number_on_hand"
  },
  "is_disabled": false,
  "is_public": true,
  "threshold": 1000
}

Anfrage

POST /alerts
Datentyp
Beschreibung
Anfrage
HTTPRequest
body
HTTP-Text
HTTPBody-Definition maximieren...
body
Benachrichtigung
Definition für Benachrichtigung maximieren...
Angewendete_Dashboard_Filter
Vergleichstyp
String
Diese Property gibt an, welche Art von Vergleich wir durchführen. Für Zeitachsenbenachrichtigungen sind nur bestimmte Bedingungstypen gültig. Weitere Informationen finden Sie unter [Bedingungungen für Benachrichtigungen festlegen](https://cloud.google.com/looker/docs/sharing-and-publishing/create-alerts#setting_alert_conditions) Gültige Werte sind: „EQUAL_TO“, „GREATER_THAN“, „GREATER_THAN_OR_EQUAL_TO“, „LESS_THAN“, „LESS_THAN_TH_BY_BY_DEC_BY_DOWN_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_BY_BY_DEC_BY_BY_BY_BY_BY_BY_BY_BY_BY_BY_BY_BY_BY_BY_BY_BY_BY)) .
cron
String
Vixie-Style-Crontab-Spezifikation bei der Ausführung. Bei Mindestwert muss es länger als 15 Minuten sein.
Benutzerdefinierte_URL_Basis
String
Domain für die benutzerdefinierte URL, die vom Ersteller der Benachrichtigung aus der Zulassungsliste der vom Administrator definierten Domain ausgewählt wurde
Benutzerdefinierte URL-Parameter
String
Parameter und Pfad für die benutzerdefinierte URL, die vom Ersteller der Benachrichtigung definiert wurde
Benutzerdefiniertes_URL-Label
String
Label für die benutzerdefinierte URL, die vom Ersteller der Benachrichtigung definiert wurde
Benutzerdefinierte_URL
boolean
Boolescher Wert, um zu ermitteln, ob die benutzerdefinierte URL verwendet werden soll
Benutzerdefinierter_Titel
String
Ein optionaler benutzerdefinierter Titel für die Benachrichtigung
Dashboard_Element_ID
String
ID des Dashboard-Elements, das der Benachrichtigung zugeordnet ist. Siehe [dashboard_element()](#!/Dashboard/DashboardElement)
description
String
Eine optionale Beschreibung für die Benachrichtigung. Sie ergänzt den Titel.
Feld
Das Feld, in dem der Benachrichtigungsschwellenwert verglichen wird, wann das Senden von Benachrichtigungen bestimmt wird
gefolgt
boolean
Gibt an, ob der Nutzer dieser Benachrichtigung folgt.
verfolgbar
boolean
Ob die Benachrichtigung nachvollziehbar ist
id
String
ID der Benachrichtigung
Ist_deaktiviert
boolean
Gibt an, ob die Benachrichtigung deaktiviert ist
Grund für die Deaktivierung
String
Grund für das Deaktivieren der Benachrichtigung
ist_öffentlich
boolean
Gibt an, ob die Benachrichtigung öffentlich ist
investigative_content_type
String
Der Typ der Prüfungsinhalte: „dashboard“.
investigative_content_id
String
ID des investigativen Inhalts Bei Dashboards ist dies die Dashboard-ID.
investigativer_Inhaltstitel
String
Der Titel des investigativen Inhalts.
Lookml-Dashboard_ID
String
ID des LookML-Dashboards, das der Benachrichtigung zugeordnet ist
Lookml-Link-ID
String
ID des LookML-Dashboard-Elements, das der Benachrichtigung zugeordnet ist
Inhaber-ID
String
Nutzer-ID des Inhabers der Benachrichtigung
Eigentümer_Anzeigename
String
Anzeigename des Inhabers der Benachrichtigung
Schwellenwert
Zahl
Wert des Schwellenwerts für Benachrichtigungen
Zeitreihenzustand
(Nur Schreibzugriff) (Optional) Wird nur beim Erstellen von Zeitreihenbenachrichtigungen verwendet. Sie wird verwendet, um eine Startzeit zu bestimmen, bei der Benachrichtigungen noch einmal ausgewertet werden. Andernfalls werden Benachrichtigungen für alle Zeitreihendaten ausgeführt. Weitere Informationen finden Sie in [docs](https://cloud.google.com/looker/docs/sharing-and-publishing/create-alerts). Beispiel „{latest_time_series_id: ‚2020-09-17‘“, vorherige_Zeitreihe_ID: „2020-09-16“}“.

Antwort

200: Die Benachrichtigung wird gespeichert.

Datentyp
Beschreibung
(Objekt)
Angewendete_Dashboard_Filter
Definition von AlertAppliedDashboardFilter maximieren...
Filtertitel
String
Feldtitel. Siehe [DashboardFilter.title] in [DashboardFilter](#!/types/DashboardFilter). Beispiel für „Name“
field_name
String
Feldname. Informationen zu „DashboardFilter.dimension“ in [DashboardFilter](#!/types/DashboardFilter) Beispiel für „distribution_centers.name“
Filterwert
String
Feldwert. [Filterausdrücke](https://cloud.google.com/looker/docs/reference/filter-Ausdrücke). Beispiel: „Berlin“
Filterbeschreibung
String
Für Menschen lesbare Filterbeschreibung. Sie kann null oder automatisch generiert sein. Beispiel: ist Los Angeles, Kalifornien
Vergleichstyp
String
Diese Property gibt an, welche Art von Vergleich wir durchführen. Für Zeitachsenbenachrichtigungen sind nur bestimmte Bedingungstypen gültig. Weitere Informationen finden Sie unter [Bedingungungen für Benachrichtigungen festlegen](https://cloud.google.com/looker/docs/sharing-and-publishing/create-alerts#setting_alert_conditions) Gültige Werte sind: „EQUAL_TO“, „GREATER_THAN“, „GREATER_THAN_OR_EQUAL_TO“, „LESS_THAN“, „LESS_THAN_TH_BY_BY_DEC_BY_DOWN_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_DEC_BY_BY_BY_DEC_BY_BY_BY_BY_BY_BY_BY_BY_BY_BY_BY_BY_BY_BY_BY_BY_BY)) .
cron
String
Vixie-Style-Crontab-Spezifikation bei der Ausführung. Bei Mindestwert muss es länger als 15 Minuten sein.
Benutzerdefinierte_URL_Basis
String
Domain für die benutzerdefinierte URL, die vom Ersteller der Benachrichtigung aus der Zulassungsliste der vom Administrator definierten Domain ausgewählt wurde
Benutzerdefinierte URL-Parameter
String
Parameter und Pfad für die benutzerdefinierte URL, die vom Ersteller der Benachrichtigung definiert wurde
Benutzerdefiniertes_URL-Label
String
Label für die benutzerdefinierte URL, die vom Ersteller der Benachrichtigung definiert wurde
Benutzerdefinierte_URL
boolean
Boolescher Wert, um zu ermitteln, ob die benutzerdefinierte URL verwendet werden soll
Benutzerdefinierter_Titel
String
Ein optionaler benutzerdefinierter Titel für die Benachrichtigung
Dashboard_Element_ID
String
ID des Dashboard-Elements, das der Benachrichtigung zugeordnet ist. Siehe [dashboard_element()](#!/Dashboard/DashboardElement)
description
String
Eine optionale Beschreibung für die Benachrichtigung. Sie ergänzt den Titel.
AlertDestination-Definition maximieren...
Zieltyp
String
Der Typ des Ziels, an das die Benachrichtigung gesendet wird, ist „EMAIL“ und „ACTION_HUB“.
E-Mail-Adresse
String
E-Mail-Adresse für den E-Mail-Typ
action_hub_integration_id
String
Aktions-Hub-Integrations-ID für den Typ „action_hub“. [Integration](#!/types/Integration)
action_hub_form_params_json
String
JSON-Aktions-Hub-Formularparameter für den Typ „action_hub“ [IntegrationParam](#!/types/IntegrationParam)
Feld
Das Feld, in dem der Benachrichtigungsschwellenwert verglichen wird, wann das Senden von Benachrichtigungen bestimmt wird
AlertField-Definition maximieren...
title
String
Titel des Felds Normalerweise automatisch generiert, um den Feldnamen und die zugehörigen Filter zu berücksichtigen
name
String
Name des Felds. Hat das Format .Weitere Informationen finden Sie unter [docs](https://cloud.google.com/looker/docs/sharing-and-publishing/create-alerts).
AlertFieldFilter-Definition maximieren...
field_name
String
Feldname. Hat das Format .
Feldwert
Feldwert. Hängt vom Feldtyp ab: numerischer Wert oder String. Für den Typ [Ort](https://cloud.google.com/looker/docs/reference/field-reference/dimension-type-reference#location) ist es eine Liste von Gleitkommazahlen. Beispiel: [1,0, 56,0]
Filterwert
String
Filterwert: In der Regel null, außer für den Typ [Ort](https://cloud.google.com/looker/docs/reference/field-reference/dimension-type-reference#location) Sie ist ein String aus Breiten- und Längengrad,z. B. „1.0,56.0“.
gefolgt
boolean
Gibt an, ob der Nutzer dieser Benachrichtigung folgt.
verfolgbar
boolean
Ob die Benachrichtigung nachvollziehbar ist
id
String
ID der Benachrichtigung
Ist_deaktiviert
boolean
Gibt an, ob die Benachrichtigung deaktiviert ist
Grund für die Deaktivierung
String
Grund für das Deaktivieren der Benachrichtigung
ist_öffentlich
boolean
Gibt an, ob die Benachrichtigung öffentlich ist
investigative_content_type
String
Der Typ der Prüfungsinhalte: „dashboard“.
investigative_content_id
String
ID des investigativen Inhalts Bei Dashboards ist dies die Dashboard-ID.
investigativer_Inhaltstitel
String
Der Titel des investigativen Inhalts.
Lookml-Dashboard_ID
String
ID des LookML-Dashboards, das der Benachrichtigung zugeordnet ist
Lookml-Link-ID
String
ID des LookML-Dashboard-Elements, das der Benachrichtigung zugeordnet ist
Inhaber-ID
String
Nutzer-ID des Inhabers der Benachrichtigung
Eigentümer_Anzeigename
String
Anzeigename des Inhabers der Benachrichtigung
Schwellenwert
Zahl
Wert des Schwellenwerts für Benachrichtigungen
Zeitreihenzustand
(Nur Schreibzugriff) (Optional) Wird nur beim Erstellen von Zeitreihenbenachrichtigungen verwendet. Sie wird verwendet, um eine Startzeit zu bestimmen, bei der Benachrichtigungen noch einmal ausgewertet werden. Andernfalls werden Benachrichtigungen für alle Zeitreihendaten ausgeführt. Weitere Informationen finden Sie in [docs](https://cloud.google.com/looker/docs/sharing-and-publishing/create-alerts). Beispiel „{latest_time_series_id: ‚2020-09-17‘“, vorherige_Zeitreihe_ID: „2020-09-16“}“.
Definition von AlertConditionState maximieren...
vorherige_Zeitreihen-ID
String
(Nur Schreibzugriff) Der zweithäufigste Zeitstring der Benachrichtigung.
neueste_Zeitreihen-ID
String
(Nur Schreibzugriff) Der letzte Zeitstring, den die Benachrichtigung gesehen hat.

400: Ungültige Anfrage

Datentyp
Beschreibung
(Objekt)
nachricht
String
Fehlerdetails
Dokumentations-URL
String
Link zur Dokumentation

404: Nicht gefunden

Datentyp
Beschreibung
(Objekt)
nachricht
String
Fehlerdetails
Dokumentations-URL
String
Link zur Dokumentation

405: Ressource kann nicht geändert werden

Datentyp
Beschreibung
(Objekt)
nachricht
String
Fehlerdetails
Dokumentations-URL
String
Link zur Dokumentation

409: Ressource ist bereits vorhanden

Datentyp
Beschreibung
(Objekt)
nachricht
String
Fehlerdetails
Dokumentations-URL
String
Link zur Dokumentation

422: Validierungsfehler

Datentyp
Beschreibung
nachricht
String
Fehlerdetails
ValidationErrorDetail-Definition maximieren...
Feld
String
Feld mit Fehler
Code
String
Fehlercode
nachricht
String
Fehlermeldung
Dokumentations-URL
String
Link zur Dokumentation
Dokumentations-URL
String
Link zur Dokumentation

429: Zu viele Anfragen

Datentyp
Beschreibung
(Objekt)
nachricht
String
Fehlerdetails
Dokumentations-URL
String
Link zur Dokumentation