Versão 4.0.23.4
Crie um novo alerta e retorne os detalhes do objeto recém-criado.
Campos obrigatórios: field
, destinations
, comparison_type
, threshold
e cron
Exemplo de solicitação:
Executar alerta no elemento do painel "103" às 5h todos os dias. Envie um e-mail para "test@test.com" se o inventário de Los Angeles (usando o filtro do painel Warehouse Name
) for menor que 1.000.
{
"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
}
Solicitação
POST
/alerts
Tipo de dados
Descrição
Solicitação
body
Expandir definição HTTPBody...
body
Alerta
Expandir a definição do alerta...
painéis_aplicados_filtros
tipo_de_comparação
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
Especificação do crontab do estilo Vixie quando ser executada. O intervalo mínimo precisa ser maior que 15 minutos
base_url_personalizada
Domínio do URL personalizado selecionado pelo criador de alertas na lista de permissões do domínio definida pelo administrador
custom_url_params
Parâmetros e caminho do URL personalizado definido pelo criador do alerta
custom_url_label [rótulo_de_url_personalizado]
Rótulo do URL personalizado definido pelo criador do alerta
mostrar_URL_personalizado
Booleano para determinar se o URL personalizado deve ser usado
título_personalizado
Um título opcional definido pelo usuário para o alerta
painel_element_id [código_do_elemento_do_painel]
ID do elemento do painel associado ao alerta. Consulte [dashboard_element()](#!/Dashboard/DashboardElement)
Descrição
Uma descrição opcional para o alerta. Isso complementa o título
destinos
campo
O campo em que o limite de alerta é comparado ao determinar quando enviar notificações
está seguindo
lock
Se o usuário segue ou não este alerta.
seguidos
lock
Se o alerta é ou não seguido
id
lock
ID do alerta
is_disabled
Se o alerta está desativado ou não
motivo_desativado
Motivo para desativar o alerta
é_público
Se o alerta é público ou não
tipo de conteúdo investigativo
Tipo de conteúdo investigativo. Os valores válidos são: "painel".
investigation_content_id
O ID do conteúdo investigativo. Para painéis, este será o ID do painel
título_do_estudo investigativo
lock
O título do conteúdo investigativo.
lookml_dashboard_id
ID do painel do LookML associado ao alerta
lookml_link_id
Código do elemento do painel do LookML associado ao alerta.
ID do proprietário
ID do usuário do proprietário do alerta
nome_do_display_do_proprietário
lock
Nome de exibição do proprietário do alerta
threshold
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' }`.
Resposta
200: o alerta é salvo.
Tipo de dados
Descrição
(objeto)
painéis_aplicados_filtros
Expandir definição de AlertAppliedDashboardFilter...
título_filtro
Título do campo. Consulte "DashboardFilter.title" em [DashboardFilter](#!/types/DashboardFilter). Exemplo de "Nome"
field_name
Nome do campo. Consulte `DashboardFilter.dimension` em [DashboardFilter](#!/types/DashboardFilter). Exemplo: "distribution_centers.name"
valor_do_filtro
Valor do campo. [Expressões de filtro](https://cloud.google.com/looker/docs/reference/filter-expressions). Exemplo "Los Angeles CA"
descrição_do_filtro
lock
Descrição do filtro legível. Ele pode ser nulo ou gerado automaticamente. Exemplo "é Los Angeles CA"
tipo_de_comparação
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
Especificação do crontab do estilo Vixie quando ser executada. O intervalo mínimo precisa ser maior que 15 minutos
base_url_personalizada
Domínio do URL personalizado selecionado pelo criador de alertas na lista de permissões do domínio definida pelo administrador
custom_url_params
Parâmetros e caminho do URL personalizado definido pelo criador do alerta
custom_url_label [rótulo_de_url_personalizado]
Rótulo do URL personalizado definido pelo criador do alerta
mostrar_URL_personalizado
Booleano para determinar se o URL personalizado deve ser usado
título_personalizado
Um título opcional definido pelo usuário para o alerta
painel_element_id [código_do_elemento_do_painel]
ID do elemento do painel associado ao alerta. Consulte [dashboard_element()](#!/Dashboard/DashboardElement)
Descrição
Uma descrição opcional para o alerta. Isso complementa o título
destinos
Expandir a definição do AlertDestination...
tipo_de_destino
O tipo de destino para o qual o alerta será enviado para os valores válidos é: "EMAIL", "ACTION_HUB".
endereço_de_e-mail
Endereço de e-mail do tipo "e-mail"
action_hub_integration_id
ID de integração do hub de ações para o tipo "action_hub". [Integração](#!/types/Integration)
action_hub_form_params_json
JSON de parâmetros do formulário do hub de ação para o tipo "action_hub" [IntegrationParam](#!/types/IntegrationParam)
campo
O campo em que o limite de alerta é comparado ao determinar quando enviar notificações
Expandir a definição do AlertField...
title
Título do campo. Geralmente gerado automaticamente para refletir o nome do campo e os filtros dele.
nome
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
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
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
lock
Se o usuário segue ou não este alerta.
seguidos
lock
Se o alerta é ou não seguido
id
lock
ID do alerta
is_disabled
Se o alerta está desativado ou não
motivo_desativado
Motivo para desativar o alerta
é_público
Se o alerta é público ou não
tipo de conteúdo investigativo
Tipo de conteúdo investigativo. Os valores válidos são: "painel".
investigation_content_id
O ID do conteúdo investigativo. Para painéis, este será o ID do painel
título_do_estudo investigativo
lock
O título do conteúdo investigativo.
lookml_dashboard_id
ID do painel do LookML associado ao alerta
lookml_link_id
Código do elemento do painel do LookML associado ao alerta.
ID do proprietário
ID do usuário do proprietário do alerta
nome_do_display_do_proprietário
lock
Nome de exibição do proprietário do alerta
threshold
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
(Somente gravação) A segunda sequência de tempo mais recente que o alerta visualizou.
ID de série_mais recente
(Somente gravação) String de tempo mais recente visualizada pelo alerta.
400: Solicitação inválida
Tipo de dados
Descrição
(objeto)
mensagem
lock
Detalhes do erro
url_da_documentação
lock
Link da documentação
404: não encontrado
Tipo de dados
Descrição
(objeto)
mensagem
lock
Detalhes do erro
url_da_documentação
lock
Link da documentação
405: o recurso não pode ser modificado
Tipo de dados
Descrição
(objeto)
mensagem
lock
Detalhes do erro
url_da_documentação
lock
Link da documentação
409: recurso já existe
Tipo de dados
Descrição
(objeto)
mensagem
lock
Detalhes do erro
url_da_documentação
lock
Link da documentação
422: erro de validação
Tipo de dados
Descrição
(objeto)
mensagem
lock
Detalhes do erro
erros
Expandir a definição de ValidationErrorDetail...
campo
lock
Campo com erro
código
lock
Código do erro
mensagem
lock
Mensagem de erro
url_da_documentação
lock
Link da documentação
url_da_documentação
lock
Link da documentação
429: Solicitações demais
Tipo de dados
Descrição
(objeto)
mensagem
lock
Detalhes do erro
url_da_documentação
lock
Link da documentação