Alertas de búsqueda

Versión 4.0.23.6 (más reciente)

Alertas de búsqueda

Solicitud

OBTENER /alerts/search
Tipo de datos
Descripción
Solicitud
HTTPRequest
verá la consulta cuando se guarde
HTTPQuery
Expandir definición de HTTPQuery...
límite
integer
Cantidad de resultados que se mostrarán (opcional con “offset”).
offset
integer
(Opcional) Cantidad de resultados que se omiten antes de mostrar cualquiera (se usa con "límite").
group_by
string
(Opcional) Dimensión según la cual se deben ordenar los resultados(`dashboard` | `owner`)
campos
string
Campos solicitados (opcional).
inhabilitada
booleano
(Opcional) Filtre para mostrar solo las alertas habilitadas o inhabilitadas.
frequency
string
(Opcional) Filtre la frecuencia de las alertas, como: mensual, semanal, diaria, por hora, minutos.
condition_met,
booleano
(Opcional) Filtre si la alerta cumplió con su condición cuando se ejecutó por última vez.
último_ejecución_inicio
string
(Opcional) Filtre el rango de inicio de la última vez que se ejecutaron las alertas. Ejemplo: 2021-01-01T01:01:01-08:00.
última_ejecución_de_ejecución
string
(Opcional) Filtre el rango de inicio de la última vez que se ejecutaron las alertas. Ejemplo: 2021-01-01T01:01:01-08:00.
todos_los_propietarios
booleano
(Solo administradores) (Opcional) Filtre todos los propietarios.

Respuesta

200: Alerta

Tipo de datos
Descripción
(array)
Alerta[]
Filtro_panel_aplicado
Expandir la definición de AlertAppliedDashboardFilter...
filtrar_título
string
Título del campo. Consulta “DashboardFilter.title” en [DashboardFilter](#!/types/DashboardFilter) Ejemplo de "Name"
field_name
string
Nombre del campo. Consulta "DashboardFilter.dimension" en [DashboardFilter](#!/types/DashboardFilter). Ejemplo: “distribution_centers.name”
valor_filtro
string
Valor del campo. [Expresiones de filtros](https://cloud.google.com/looker/docs/reference/filter-expressions). Ejemplo: “Los Ángeles CA”
filtrar_descripción
string
Descripción del filtro legible para las personas. Puede ser nulo o generado automáticamente. Ejemplo: "es Los Ángeles CA"
tipo_comparación
string
Esta propiedad informa el tipo de comparación que estamos realizando. Solo ciertos tipos de condiciones son válidos para las alertas de series temporales. Para obtener más información, consulta [Configuración de las condiciones de alerta](https://cloud.google.com/looker/docs/sharing-and-publishing/creating-alerts#setting_alert_conditions). Estos son los valores válidos: "EQUAL_TO", "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "LES_THAN", "LESS_THAN_OR_EQUAL_TO", "INCREASES_BYESBY"
cron
string
Especificación de crontab de estilo Vixie cuando se debe ejecutar. Al menos, debe durar más de 15 minutos.
base_url_personalizada
string
Dominio de la URL personalizada que seleccionó el creador de alertas de la lista de entidades permitidas del dominio definido por el administrador
parámetros_url_personalizados
string
Parámetros y ruta para la URL personalizada definida por el creador de la alerta
etiqueta_URL_personalizada
string
Etiqueta de la URL personalizada definida por el creador de la alerta
URL_personalizada_programa
booleano
Booleano para determinar si se debe usar la URL personalizada.
título_personalizado
string
Es un título opcional definido por el usuario para la alerta.
panel_element_id
string
ID del elemento del panel asociado con la alerta. Consulta [dashboard_element()](#!/Dashboard/DashboardElement)
description
string
Una descripción opcional de la alerta. Esto complementa el título
destinos
Expandir la definición de AlertDestination...
tipo_destino
string
El tipo de destino que se enviará a los valores válidos será "EMAIL", "ACTION_HUB".
dirección_de_correo
string
Dirección de correo electrónico del tipo “email”
action_hub_integration_id
string
Es el ID de integración del centro de acciones para el tipo "action_hub". [Integración](#!/types/Integration)
action_hub_form_params_json
string
JSON de parámetros de formulario del centro de acciones para el tipo "action_hub" [IntegrationParam](#!/types/IntegrationParam)
campo
El campo con el que se compara el umbral de las alertas cuando se determina cuándo enviar notificaciones
Expandir la definición de AlertField...
title
string
Título del campo. Por lo general, se genera automáticamente para reflejar el nombre del campo y sus filtros.
del espacio
string
Nombre del campo. Tiene el formato `.` Consulta [docs](https://cloud.google.com/looker/docs/sharing-and-publishing/creating-alerts) para obtener más detalles
Expandir la definición de AlertFieldFilter...
field_name
string
Nombre del campo. Tiene el formato "."
valor_campo
Valor del campo. Depende del tipo de campo: numérico o de string. Para el tipo de [ubicación](https://cloud.google.com/looker/docs/reference/field-reference/dimension-type-reference#location), es una lista de flotantes. Ejemplo `[1.0, 56.0]`
valor_filtro
string
Valor del filtro. Por lo general, es nulo, excepto para el tipo [location](https://cloud.google.com/looker/docs/reference/field-reference/dimension-type-reference#location). Será una string de latitud y longitud, es decir, "'1.0,56.0'"
seguidos
booleano
Indica si el usuario sigue o no esta alerta.
se puede seguir
booleano
Si se puede seguir o no la alerta
id
string
ID de la alerta
está_inhabilitado
booleano
Si la alerta está inhabilitada o no
inhabilitado_motivo
string
Motivo para inhabilitar la alerta
es_público
booleano
Si la alerta es pública o no
tipo_de_contenido_investigativo
string
El tipo de contenido de investigación Los valores válidos son: "dashboard".
ID del contenido de investigación
string
Es el ID del contenido de investigación. Para los paneles, este será el ID del panel
título_contenido_investigativo
string
Es el título del contenido de investigación.
look_dashboard_id
string
ID del panel de LookML asociado con la alerta
look_link_id
string
ID del elemento del panel de LookML asociado con la alerta
id_propietario
string
ID de usuario del propietario de la alerta
nombre_visualización_propietario
string
Nombre visible del propietario de la alerta
threshold
número
Valor del umbral de alerta
estado_de_serie_temporal
(Solo escritura) (opcional): Solo se usa cuando se crean alertas de serie temporal por primera vez. Se usa para elegir una referencia de hora de inicio a partir de la cual se volverán a evaluar las alertas. Sin ella, las alertas se ejecutan en todos los datos de series temporales. Consulta [docs](https://cloud.google.com/looker/docs/sharing-and-publishing/creating-alerts) para obtener más detalles. Ejemplo `{ last_time_series_id: '2020-09-17', previous_time_series_id: '2020-09-16' }`.
Expandir la definición de AlertConditionState...
id_serie_anterior
string
(Solo escritura) Es la segunda string de tiempo más reciente que vio la alerta.
id_serie_última_hora
string
(Solo escritura) String más reciente que ha visto la alerta.

400: Bad Request

Tipo de datos
Descripción
(objeto)
mensaje,
string
Detalles del error
url_documentación
string
Vínculo a la documentación

403: Permiso denegado

Tipo de datos
Descripción
(objeto)
mensaje,
string
Detalles del error
url_documentación
string
Vínculo a la documentación

404: No encontrado

Tipo de datos
Descripción
(objeto)
mensaje,
string
Detalles del error
url_documentación
string
Vínculo a la documentación

Ejemplos