Receber um alerta

Versão 4.0.23.6 (mais recente)

Receber um alerta por um determinado código

Solicitação

GET /alerts/{alert_id}
Tipo de dados
Descrição
Solicitação
HTTPRequest
path
HTTPPath
Expandir definição HTTPPath...
ID do alerta
string
ID de um alerta

Resposta

200: Alerta

Tipo de dados
Descrição
(objeto)
painéis_aplicados_filtros
Expandir definição de AlertAppliedDashboardFilter...
título_filtro
string
Título do campo. Consulte "DashboardFilter.title" em [DashboardFilter](#!/types/DashboardFilter). Exemplo de "Nome"
field_name
string
Nome do campo. Consulte `DashboardFilter.dimension` em [DashboardFilter](#!/types/DashboardFilter). Exemplo: "distribution_centers.name"
valor_do_filtro
string
Valor do campo. [Expressões de filtro](https://cloud.google.com/looker/docs/reference/filter-expressions). Exemplo "Los Angeles CA"
descrição_do_filtro
string
Descrição do filtro legível. Ele pode ser nulo ou gerado automaticamente. Exemplo "é Los Angeles CA"
tipo_de_comparação
string
Essa propriedade informa a verificação do tipo de comparação que estamos realizando. Somente certos tipos de condição são válidos para alertas de série temporal. Veja mais detalhes em [Como definir condições de alerta](https://cloud.google.com/looker/docs/sharing-and-publishing/creating-alerts#setting_alert_conditions). Os valores válidos são: "EQUAL_TO", "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "DECSES_BY", "INCREASESES_BY", "INCREASESES"
cron
string
Especificação do crontab do estilo Vixie quando ser executada. O intervalo mínimo precisa ser maior que 15 minutos
base_url_personalizada
string
Domínio do URL personalizado selecionado pelo criador de alertas na lista de permissões do domínio definida pelo administrador
custom_url_params
string
Parâmetros e caminho do URL personalizado definido pelo criador do alerta
custom_url_label [rótulo_de_url_personalizado]
string
Rótulo do URL personalizado definido pelo criador do alerta
mostrar_URL_personalizado
booleano
Booleano para determinar se o URL personalizado deve ser usado
título_personalizado
string
Um título opcional definido pelo usuário para o alerta
painel_element_id [código_do_elemento_do_painel]
string
ID do elemento do painel associado ao alerta. Consulte [dashboard_element()](#!/Dashboard/DashboardElement)
Descrição
string
Uma descrição opcional para o alerta. Isso complementa o título
destinos
Expandir a definição do AlertDestination...
tipo_de_destino
string
O tipo de destino para o qual o alerta será enviado para os valores válidos é: "EMAIL", "ACTION_HUB".
endereço_de_e-mail
string
Endereço de e-mail do tipo "e-mail"
action_hub_integration_id
string
ID de integração do hub de ações para o tipo "action_hub". [Integração](#!/types/Integration)
action_hub_form_params_json
string
JSON de parâmetros do formulário do hub de ação para o tipo "action_hub" [IntegrationParam](#!/types/IntegrationParam)
campo
AlertField (em inglês)
O campo em que o limite de alerta é comparado ao determinar quando enviar notificações
Expandir a definição do AlertField...
title
string
Título do campo. Geralmente gerado automaticamente para refletir o nome do campo e os filtros dele.
nome
string
Nome do campo. Tem o formato `.` Para mais detalhes, consulte [docs](https://cloud.google.com/looker/docs/sharing-and-publishing/creating-alerts).
filter
Expandir a definição do AlertFieldFilter...
field_name
string
Nome do campo. Tem o formato `.`
valor_do_campo
Valor do campo. Depende do tipo de campo: numérico ou de string. Para o tipo [location](https://cloud.google.com/looker/docs/reference/field-reference/dimension-type-reference#location), ele é uma lista de pontos flutuantes. Exemplo `[1.0, 56.0]`
valor_do_filtro
string
Valor do filtro. Normalmente nulo, exceto para o tipo [location](https://cloud.google.com/looker/docs/reference/field-reference/dimension-type-reference#location). Será uma string de latitude, longitude, isto é, `'1.0,56.0'`
está seguindo
booleano
Se o usuário segue ou não este alerta.
seguidos
booleano
Se o alerta é ou não seguido
id
string
ID do alerta
is_disabled
booleano
Se o alerta está desativado ou não
motivo_desativado
string
Motivo para desativar o alerta
é_público
booleano
Se o alerta é público ou não
tipo de conteúdo investigativo
string
Tipo de conteúdo investigativo. Os valores válidos são: "painel".
investigation_content_id
string
O ID do conteúdo investigativo. Para painéis, este será o ID do painel
título_do_estudo investigativo
string
O título do conteúdo investigativo.
lookml_dashboard_id
string
ID do painel do LookML associado ao alerta
lookml_link_id
string
Código do elemento do painel do LookML associado ao alerta.
ID do proprietário
string
ID do usuário do proprietário do alerta
nome_do_display_do_proprietário
string
Nome de exibição do proprietário do alerta
threshold
number
Valor do limite de alerta
estado_da_série_de_tempo
(Somente gravação) (Opcional) Usado somente ao criar alertas de série temporal pela primeira vez. Ele é usado para escolher uma referência de horário de início a partir da qual os alertas serão avaliados novamente. Sem ele, os alertas são executados em todos os dados de série temporal. Consulte [documentos](https://cloud.google.com/looker/docs/sharing-and-publishing/creating-alerts) para ver mais detalhes. Exemplo: `{ latest_time_series_id: '2020-09-17', previous_time_series_id: '2020-09-16' }`.
Expandir a definição do AlertConditionState...
id_série_tempo_anterior
string
(Somente gravação) A segunda sequência de tempo mais recente que o alerta visualizou.
ID de série_mais recente
string
(Somente gravação) String de tempo mais recente visualizada pelo alerta.

400: Solicitação inválida

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

404: não encontrado

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação